Skip to main content
GET
/
v1
/
beneficiaries
List beneficiaries
curl --request GET \
  --url https://api.antonpayments.com/v1/beneficiaries \
  --header 'Authorization: Bearer <token>'
{ "data": [ { "id": "ben_01HX8Z9K0M2N3P4Q5R6S7T8UA1", "merchant_id": "mer_01HX8Z9K0M2N3P4Q5R6S7T8UZZ", "type": "individual", "status": "active", "display_name": "Jane Smith", "country": "GB", "external_ref": "contractor-1042", "metadata": { "department": "engineering" }, "created_at": "2026-04-15T14:30:00Z", "updated_at": "2026-04-15T14:30:00Z" } ], "has_more": true, "next_cursor": "<string>" }

Authorizations

​
Authorization
string
header
required

API keys are opaque strings prefixed by environment:

  • ak_live_* — production keys, accepted only on api.antonpayments.com.
  • ak_test_* — sandbox keys, accepted only on api.antonpayments.dev.

Include your key in the Authorization header: Bearer ak_test_....

Query Parameters

​
limit
integer
default:20

Items per page. Maximum 100.

Required range: 1 <= x <= 100
​
cursor
string

Opaque cursor returned by a previous list response. Omit for the first page.

​
status
enum<string>

Filter by beneficiary status.

Available options:
active,
archived,
blocked
​
type
enum<string>

Filter by beneficiary type.

Available options:
individual,
business
​
country
string

Filter by ISO-3166 alpha-2 country code. ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$
Example:

"US"

Response

Paginated list of beneficiaries.

​
data
object[]
required

Array of results for this page. Element schema varies by endpoint.

​
has_more
boolean
required

Whether more results exist beyond this page.

​
next_cursor
string

Cursor for the next page. Present only when has_more is true.