Skip to main content
GET
/
api
/
platform
/
cross-border
/
payout-banks
List Payout Banks
curl --request GET \
  --url https://api.paywint.com/api/platform/cross-border/payout-banks \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>'
{
  "success": true,
  "message": "Operation completed.",
  "data": [
    {
      "id": 913212,
      "name": "All Bank of India",
      "country_code": "IN",
      "country_name": "INDIA",
      "state_id": 0,
      "state": "",
      "city_id": 99999,
      "city": "Sin ciudad",
      "address": "",
      "currencies": [
        {
          "code": "INR",
          "name": "RUPIA INDIA"
        }
      ]
    }
  ],
  "queryGeneratedTime": 1718006400
}

Headers

X-Platform-ID
string<uuid>
required

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

X-Signature
string
required

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

Query Parameters

currency
string
required

Payout currency ISO code. Currently only PKR (Pakistan) is supported.

Response

Successful Response

success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

message
string
default:Success

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

Example:

"Operation completed."

data
UnitellerBranchItem · object[] | null

The main response payload, if applicable

queryGeneratedTime
number | null
default:1783409763.80796

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

Example:

1718006400