Skip to main content
GET
/
api
/
platform
/
cross-border
/
payee
/
addresses
/
{user_id}
List Payee Addresses
curl --request GET \
  --url https://api.paywint.com/api/platform/cross-border/payee/addresses/{user_id} \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>'
{
  "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.

Query Parameters

​
payee_id
string<uuid>
required

Payee's user id to filter the addresses to a single payee.

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