Skip to main content
GET
/
api
/
platform
/
cross-border
/
payee-rules
Get Payee Rules (Mandatory Fields)
curl --request GET \
  --url https://api.paywint.com/api/platform/cross-border/payee-rules \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "country_code": "<string>",
    "country_name": "<string>",
    "mandatory_fields": [
      {
        "tag": "<string>",
        "label": "<string>",
        "data_type": "<string>",
        "length": 123
      }
    ],
    "optional_fields": [
      {
        "tag": "<string>",
        "label": "<string>",
        "data_type": "<string>",
        "length": 123
      }
    ],
    "account": {},
    "documents_allowed": {},
    "bank_identifier_type": "<string>"
  },
  "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

​
country
string
required

Payee country ISO2, e.g. IN.

​
currency
string
required

Payout currency ISO code, e.g. INR.

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
PayeeRuleItem · 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