Skip to main content
GET
/
v1
/
beneficiaries
/
{id}
/
instruments
List a beneficiary's instruments
curl --request GET \
  --url https://api.antonpayments.com/v1/beneficiaries/{id}/instruments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "ins_01HX8Z9K0M2N3P4Q5R6S7T8UA2",
      "beneficiary_id": "ben_01HX8Z9K0M2N3P4Q5R6S7T8UA1",
      "merchant_id": "mer_01HX8Z9K0M2N3P4Q5R6S7T8UZZ",
      "method": "iban",
      "currency": "EUR",
      "country": "DE",
      "label": "Primary EUR account",
      "display_last4": "5432",
      "display_bank": "Deutsche Bank",
      "masked_account": "DE89****5432",
      "status": "active",
      "is_default": true,
      "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_....

Path Parameters

id
string
required
Pattern: ^ben_[a-zA-Z0-9]+$

Response

List of instruments for the beneficiary.

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.