Skip to main content
POST
/
v1
/
payees
/
{id}
/
instruments
Create an instrument for a payee
curl --request POST \
  --url https://api.antonpayments.com/v1/payees/{id}/instruments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "iban",
  "credentials": {},
  "currency": "<string>",
  "country": "<string>",
  "label": "<string>",
  "is_default": false
}
'
{
  "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"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Resource identifier.

Body

application/json
method
enum<string>
required
Available options:
iban,
uk_bank,
us_bank,
ca_bank,
au_bank,
swift,
clabe,
pix,
upi,
crypto,
mobile_money,
card
credentials
object
required

Method-specific credential fields. Tokenized via Basis Theory.

currency
string
country
string
label
string
is_default
boolean
default:false

Response

Instrument created.

data
object
required