Skip to main content
POST
/
api
/
platform
/
address
/
list-payee-address
/
{user_id}
List Payee Addresses
curl --request POST \
  --url https://api.sandbox.paywint.com/api/platform/address/list-payee-address/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Platform-ID: <x-platform-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "payee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "status_code": 200,
  "message": "Success",
  "records": [
    {
      "address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
      "name": "John Smith",
      "address_line_1": "123 Main Street, Apt 4B",
      "address_line_2": "123 Main Street, Apt 4B",
      "company_name": "Meta Corp",
      "city": "New York",
      "state": "NY",
      "zipcode": "10001",
      "country": "United States",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "totalRecords": 0,
  "queryGeneratedTime": 1765631850
}

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 user

Body

application/json
​
payee_id
string<uuid>
required

Unique identifier (UUID) of the payee

Response

Successful Response

​
success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

​
status_code
integer | null
default:200

HTTP status code representing the result of the request.

​
message
string | null
default:Success

Short, human-readable message describing the outcome of the request.

​
records
ExternalContactAddressRead · object[] | null

List of result items returned for the current page.

​
totalRecords
integer | null
default:0

Total number of matching records in the database, useful for paginating the full dataset.

​
queryGeneratedTime
integer | null
default:1765631850

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