> ## 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.

# List Payout Banks

> Returns the list of supported payout banks for cross-border payments. Currently, this endpoint returns
only banks in **Pakistan (`PKR`)**. Use the returned bank `id` as the `payout_bank_id` in the
[Create a Cross-Border Payment](/api-reference/cross-boarder-payments/create-a-cross-border-payment)
endpoint. The `payout_bank_id` field is required only when the destination country is Pakistan.



## OpenAPI

````yaml GET /api/platform/cross-border/payout-banks
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/payout-banks:
    get:
      tags:
        - Platform Cross-Border
      summary: List Payout Banks
      description: >-
        Returns the list of supported payout banks for cross-border payments.
        Currently, this endpoint returns

        only banks in **Pakistan (`PKR`)**. Use the returned bank `id` as the
        `payout_bank_id` in the

        [Create a Cross-Border
        Payment](/api-reference/cross-boarder-payments/create-a-cross-border-payment)

        endpoint. The `payout_bank_id` field is required only when the
        destination country is Pakistan.
      operationId: get_payout_banks_api_platform_cross_border_payout_banks_get
      parameters:
        - name: currency
          in: query
          required: true
          schema:
            type: string
            description: >-
              Payout currency ISO code. Currently only PKR (Pakistan) is
              supported.
            title: Currency
          description: >-
            Payout currency ISO code. Currently only PKR (Pakistan) is
            supported.
          example: PKR
        - 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_list_UnitellerBranchItem__'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CommonResponse_list_UnitellerBranchItem__:
      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:
            - items:
                $ref: '#/components/schemas/UnitellerBranchItem'
              type: array
            - type: 'null'
          title: Data
          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[list[UnitellerBranchItem]]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UnitellerBranchItem:
      properties:
        id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Id
          description: Payout bank id.
          example: 913212
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Payout bank display name.
          example: All Bank of India
        country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Code
          description: Country ISO2.
          example: IN
        country_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Country Name
          description: Country name.
          example: INDIA
        state_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: State Id
          description: State id, when applicable.
          example: 0
        state:
          anyOf:
            - type: string
            - type: 'null'
          title: State
          description: State name, when applicable.
          example: ''
        city_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: City Id
          description: City id, when applicable.
          example: 99999
        city:
          anyOf:
            - type: string
            - type: 'null'
          title: City
          description: City name, when applicable.
          example: Sin ciudad
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
          description: Bank address, when provided.
          example: ''
        currencies:
          items:
            $ref: '#/components/schemas/UnitellerCurrencyAmountItem'
          type: array
          title: Currencies
          description: Currencies the bank settles, with amount limits.
      type: object
      title: UnitellerBranchItem
      description: A payout bank (getBranches).
    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
    UnitellerCurrencyAmountItem:
      properties:
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: Currency ISO code.
          example: INR
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Currency display name.
          example: RUPIA INDIA
      type: object
      title: UnitellerCurrencyAmountItem
      description: >-
        A currency offered by a payout bank/payer with its min/max payout
        amounts.

````