Skip to main content
GET
/
v2
/
beneficiaries
List beneficiaries with opaque cursor pagination
curl --request GET \
  --url https://api.example.com/v2/beneficiaries \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "accounts": [
        {
          "createdAt": "2024-01-15T10:30:00Z",
          "currency": "EUR",
          "data": {
            "bic": "DEUTDEFF",
            "iban": "DE89370400440532013000"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "active",
          "type": "iban",
          "updatedAt": "2024-01-15T10:35:00Z",
          "resolutionStatus": "resolved",
          "resolvedAccountName": "JANE DOE"
        }
      ],
      "country": "DE",
      "createdAt": "2024-01-15T10:30:00Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "John Doe",
      "status": "active",
      "type": "individual",
      "updatedAt": "2024-01-15T10:30:00Z",
      "address": "Hauptstraße 123",
      "addressLine2": "Apt 4B, 3rd Floor",
      "city": "Berlin",
      "countrySubdivision": "NY",
      "dateOfBirth": "1985-05-20",
      "email": "john.doe@example.com",
      "middleName": "James",
      "notes": "Regular client, prefers SEPA Instant",
      "postcode": "10115"
    }
  ],
  "hasMore": true,
  "nextCursor": "eyJ2IjoxLCJjcmVhdGVkQXQiOiIyMDI2LTAxLTAxVDAwOjAwOjAwLjAwMFoiLCJpZCI6IjEyM2U0NTY3LWU4OWItNDJkMy1hNDU2LTQyNjYxNDE3NDAwMCJ9",
  "object": "payout.list"
}

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Query Parameters

​
cursor
string

Opaque cursor returned by the previous page

​
limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
​
status
string
​
country
string

ISO 3166-1 alpha-2 country code

Example:

"DE"

Response

​
data
object[]
required
​
hasMore
boolean
required

Whether more items exist after this page

Example:

true

​
nextCursor
string | null
required

Opaque cursor for the next page, or null when there are no more items

Example:

"eyJ2IjoxLCJjcmVhdGVkQXQiOiIyMDI2LTAxLTAxVDAwOjAwOjAwLjAwMFoiLCJpZCI6IjEyM2U0NTY3LWU4OWItNDJkMy1hNDU2LTQyNjYxNDE3NDAwMCJ9"

​
object
enum<string>
required

Stable resource-specific collection discriminator

Available options:
beneficiary.list
Pattern: ^[a-z][a-z0-9_]*\.list$
Example:

"payout.list"