Skip to main content
PATCH
Edit a Payee Address

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.

address_id
string<uuid>
required

Unique identifier (UUID) of the cross-border address.

Body

application/json

Cross-border payee address edit — the recipient/address fields are replaced.

Deliberately excludes country (it is fixed at creation and stays the same on an edit) and the payee identity (an address cannot be re-pointed to another payee). Every field is required on an edit: the full recipient/address must be supplied, and blank/whitespace-only values are rejected.

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"

zipcode
string
required

Postal code or ZIP code.

Required string length: 1 - 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:1783679844.273462

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

Example:

1718006400