Skip to main content
POST
/
api
/
platform
/
cross-border
/
payee
/
address
/
{user_id}
Add a Payee Address
curl --request POST \
  --url https://api.paywint.com/api/platform/cross-border/payee/address/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "name": "John",
  "last_name": "Smith",
  "address_line_1": "123 Main Street, Apt 4B",
  "city": "New York",
  "state": "NY",
  "country": "IN",
  "payee_id": "f47ac10b-****-****-****-0e02b2c3d479",
  "zipcode": "10001"
}
'
{
  "success": true,
  "message": "Operation completed.",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "address_line_1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "country": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "last_name": "<string>",
    "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.

Body

application/json

Cross-border payee address create. Identify the payee by payee_id (the payee's user id).

Deliberately carries only the fields a cross-border payee needs — no address_line_2 or company_name (unlike the general ExternalContactAddressCreate).

​
name
string
required

Recipient's first name.

Required string length: 2 - 100
Example:

"John"

​
last_name
string
required

Recipient's last name.

Required string length: 1 - 100
Example:

"Smith"

​
address_line_1
string
required

Street address including apartment, suite, or unit number.

Required string length: 1 - 100
Example:

"123 Main Street, Apt 4B"

​
city
string
required

City name.

Required string length: 1 - 40
Example:

"New York"

​
state
string
required

State, province, or region.

Required string length: 1 - 30
Example:

"NY"

​
country
string
required

Payee country ISO2 code (e.g. IN). Use the iso2 value from GET /cross-border/payout-countries for the destination country.

Required string length: 2
Example:

"IN"

​
payee_id
string<uuid>
required

Payee's user id.

Example:

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

​
zipcode
string | null

Postal code or ZIP code (optional).

Maximum string length: 10
Example:

"10001"

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