Skip to main content
GET
List a Payee's Addresses

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

payee_id
string<uuid>
required

Query Parameters

user_id
string<uuid> | null

Optional. The unique ID of the user who owns this payee. Omit to look the payee up by its ID within your tenant.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

country
string | null

Optional. Filter to the address for one destination country (ISO 3166-1 alpha-2, e.g. MX). A payee holds at most one address per country, so this returns at most one row.

Example:

"MX"

Response

Successful Response

status_code
integer
required

HTTP status code for the response.

data
PayeeAddressRead · object[]
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.

row_count
integer
required

Total rows matching the request filters (not just this page).

Required range: x >= 0
limit
integer | null

Page size used for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
current_page
integer | null

1-indexed page number for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
total_page_number
integer | null

Total number of pages given the current limit. Null for cursor-paginated endpoints.

Required range: x >= 0
next_cursor
string | null

Cursor for the next page, if available.