> ## Documentation Index
> Fetch the complete documentation index at: https://developer.paywint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Payee Rules (Mandatory Fields)

> Returns the payee rules for a destination `country` (ISO2) and payout `currency`.

The response lists the **mandatory** and **optional** payee fields and the amount limits — the
fields you need to collect for the payee.



## OpenAPI

````yaml GET /api/platform/cross-border/payee-rules
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: https://api.paywint.com
  - url: https://api.sandbox.paywint.com
security: []
paths:
  /api/platform/cross-border/payee-rules:
    get:
      tags:
        - Platform Cross-Border
      summary: Get Payee Rules (Mandatory Fields)
      description: >-
        Returns the payee rules for a destination `country` (ISO2) and payout
        `currency`.


        The response lists the **mandatory** and **optional** payee fields and
        the amount limits — the

        fields you need to collect for the payee.
      operationId: get_payee_rules_api_platform_cross_border_payee_rules_get
      parameters:
        - name: country
          in: query
          required: true
          schema:
            type: string
            description: Payee country ISO2, e.g. IN.
            title: Country
          description: Payee country ISO2, e.g. IN.
          example: IN
        - name: currency
          in: query
          required: true
          schema:
            type: string
            description: Payout currency ISO code, e.g. INR.
            title: Currency
          description: Payout currency ISO code, e.g. INR.
          example: INR
        - name: X-Platform-ID
          in: header
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique platform identifier (UUID). You receive this during
              onboarding. Must be sent with every API request.
            title: X-Platform-Id
          description: >-
            Unique platform identifier (UUID). You receive this during
            onboarding. Must be sent with every API request.
        - name: X-Signature
          in: header
          required: true
          schema:
            type: string
            description: >-
              HMAC-SHA256 request signature for authentication. Use your
              platform secret key to compute it as: `METHOD + PATH + QUERY +
              BODY_HASH`.
            title: X-Signature
          description: >-
            HMAC-SHA256 request signature for authentication. Use your platform
            secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse_PayeeRuleItem_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CommonResponse_PayeeRuleItem_:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        message:
          type: string
          title: Message
          description: >-
            A short, human-readable message describing the result of the
            request.
          default: Success
          example: Operation completed.
        data:
          anyOf:
            - $ref: '#/components/schemas/PayeeRuleItem'
            - type: 'null'
          description: The main response payload, if applicable
        queryGeneratedTime:
          anyOf:
            - type: number
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            The Unix timestamp (in seconds) indicating when the response was
            generated.
          default: 1783409763.80796
          example: 1718006400
      type: object
      title: CommonResponse[PayeeRuleItem]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PayeeRuleItem:
      properties:
        country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Code
        country_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Name
        mandatory_fields:
          items:
            $ref: '#/components/schemas/PayerRuleField'
          type: array
          title: Mandatory Fields
        optional_fields:
          items:
            $ref: '#/components/schemas/PayerRuleField'
          type: array
          title: Optional Fields
        account:
          anyOf:
            - additionalProperties: true
              type: object
            - items: {}
              type: array
            - type: 'null'
          title: Account
        documents_allowed:
          anyOf:
            - additionalProperties: true
              type: object
            - items: {}
              type: array
            - type: 'null'
          title: Documents Allowed
        bank_identifier_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Identifier Type
      type: object
      title: PayeeRuleItem
      description: >-
        Partner-facing payee rules for a corridor — the response model for
        `/cross-border/payee-rules`.


        A trimmed `PayerRuleItem`: the server-resolved payer
        (`payer_id`/`payer_name`), the fixed delivery

        type and the provider `min_max_amount` limits are deliberately not
        declared, so they appear neither

        in the response nor in the OpenAPI schema. Only the payee/bank fields
        the partner must collect are

        surfaced. Build it from a resolved `PayerRuleItem` via
        `model_validate(item, from_attributes=True)`.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PayerRuleField:
      properties:
        tag:
          type: string
          title: Tag
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
        data_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Data Type
        length:
          anyOf:
            - type: integer
            - type: 'null'
          title: Length
      type: object
      required:
        - tag
      title: PayerRuleField
      description: A single mandatory/optional field from a payer's rules.

````