Skip to main content
GET
/
api
/
user-api
/
address
/
payee
/
list
/
{payee_id}
List Payee Addresses
curl --request GET \
  --url https://api.sandbox.paywint.com/api/user-api/address/payee/list/{payee_id} \
  --header 'X-Api-Key: <x-api-key>' \
  --header 'X-Api-Secret: <x-api-secret>'
{
  "success": true,
  "status_code": 200,
  "message": "Success",
  "records": [
    {
      "address_id": "a1b2c3d4-****-****-****-e5f6g7h8i9j0",
      "fist_name": "John",
      "last_name": "Doe",
      "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",
      "is_default": false,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "totalRecords": 0,
  "queryGeneratedTime": 1771679555
}

Headers

​
X-Api-Key
string
required

Your API Key (UUID format). Required to identify and authorize each request

​
X-Api-Secret
string
required

Secret associated with your API Key. Used for authenticating requests. Keep this secure.

Path Parameters

​
payee_id
string<uuid>
required

Unique identifier for the payee whose addresses are being managed.

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:1771679555

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