Skip to main content
POST
/
api
/
platform
/
cross-border
/
payee
/
bank
/
{user_id}
Add a Payee Bank
curl --request POST \
  --url https://api.paywint.com/api/platform/cross-border/payee/bank/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "bank_nick_name": "HDFC savings",
  "account_number": "<string>",
  "country": "IN",
  "bank_acc_type": "savings",
  "identifier_value": "SBIN0000123",
  "payout_bank_id": "921874"
}
'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "bank_id": "2d8c5ca1-98cb-42f7-8c1e-70a2b0b8e8f1",
    "account_number": "1234567890",
    "country": "IN",
    "bank_acc_type": "savings",
    "created_at": "2023-11-07T05:31:56Z",
    "bank_nick_name": "<string>",
    "bank_identifier_type": "IFSC",
    "bank_identifier_value": "SBIN0000123",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "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.

Path Parameters

​
user_id
string<uuid>
required

Unique identifier (UUID) of the platform user who owns the payee bank.

Body

application/json

Platform-side add cross-border payee bank request — stores the payee's bank details.

The payer is NOT fixed here: it is supplied at payout time, and the payer's mandatory fields are fetched from the payer rules and validated on each payout. So this request carries only the core bank fields plus the owning payee (payee_id).

​
payee_id
string<uuid>
required

Payee's user id.

Example:

"f47ac10b-****-****-****-0e02b2c3d479"

​
bank_nick_name
string
required

Nickname for the payee bank.

Required string length: 1 - 100
Example:

"HDFC savings"

​
account_number
string
required
Maximum string length: 64
​
country
string
required

Payee country ISO2.

Maximum string length: 80
Example:

"IN"

​
bank_acc_type
enum<string>
required

Beneficiary bank account type. Mapped to the Uniteller bankAccType code at payout time (savings -> AHO, current -> CTE, no_needed -> NON).

Available options:
savings,
current,
no_needed
Example:

"savings"

​
identifier_value
string
required

Bank identifier value for the country (IFSC for India, BSB for Australia, routing number for the US, etc.).

Maximum string length: 64
Example:

"SBIN0000123"

​
payout_bank_id
string | null

Payout bank id — only enter this for Pakistan. For every other country it is optional and can be omitted.

Maximum string length: 40
Example:

"921874"

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