Sign in

v2

latestOpenAPI 3.1.02026-07-267085761.0 MB
Platform Cross-Border

List Payout Banks

Returns the list of supported payout banks for cross-border payments. Currently, this endpoint returns banks for Pakistan (PKR) and the UAE (AED). Use the returned bank id as the payout_bank_id in the Create a Cross-Border Payment endpoint. The payout_bank_id field is required only when the destination country is Pakistan or the UAE.

get/api/platform/cross-border/payout-banks

Query parameters

currencystring required

Payout currency ISO code. Currently PKR (Pakistan) and AED (UAE) are supported.

Payout currency ISO code. Currently PKR (Pakistan) and AED (UAE) are supported.

Headers

X-Platform-IDstring uuid required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signaturestring required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

messagestring

A short, human-readable message describing the result of the request.

queryGeneratedTimenumber nullable

The Unix timestamp (in seconds) indicating when the response was generated.

Example response

{
  "success": true,
  "message": "Operation completed.",
  "data": [
    {
      "id": 913212,
      "name": "All Bank of India",
      "country_code": "IN",
      "country_name": "INDIA",
      "city_id": 99999,
      "city": "Sin ciudad",
      "currencies": [
        {
          "code": "INR",
          "name": "RUPIA INDIA"
        }
      ]
    }
  ],
  "queryGeneratedTime": 1718006400
}