Skip to main content
GET
/
v1
/
instruments
List instruments
curl --request GET \
  --url https://api.antonpayments.com/v1/instruments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "ins_abc123",
      "payee_id": "<string>",
      "merchant_id": "<string>",
      "method": "iban",
      "currency": "<string>",
      "country": "<string>",
      "label": "<string>",
      "display_last4": "<string>",
      "display_bank": "<string>",
      "display_network": "<string>",
      "masked_account": "<string>",
      "status": "active",
      "is_default": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Merchant API key: ak_live_* (production) or ak_test_* (sandbox).

Query Parameters

​
limit
integer
default:20

Maximum number of items to return (default 20, max 100).

Required range: x <= 100
​
cursor
string

Pagination cursor from previous response's next_cursor.

​
payee_id
string

Filter by payee ID.

​
method
enum<string>

Filter by instrument method.

Available options:
iban,
uk_bank,
us_bank,
ca_bank,
au_bank,
swift,
clabe,
pix,
upi,
crypto,
mobile_money,
card
​
status
enum<string>
Available options:
active,
disabled

Response

Paginated list of instruments.

​
data
object[]
required
​
has_more
boolean
required
​
next_cursor
string