Skip to main content
GET
/
v1
/
beneficiaries
/
{id}
/
instruments
List instruments for a beneficiary
curl --request GET \
  --url http://localhost:8080/v1/beneficiaries/{id}/instruments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "ins_cq1234567890abcdef",
      "beneficiary_id": "<string>",
      "merchant_id": "<string>",
      "method": "<string>",
      "currency": "<string>",
      "country": "<string>",
      "label": "<string>",
      "display_last4": "<string>",
      "display_bank": "<string>",
      "display_network": "<string>",
      "status": "active",
      "is_default": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Path Parameters

id
string
required

Resource identifier (xid format)

Response

200 - application/json

List of instruments

data
object[]
has_more
boolean