Skip to main content
GET
/
v1
/
instruments
List all instruments
curl --request GET \
  --url http://localhost:8080/v1/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_...

Query Parameters

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip

Required range: x >= 0
beneficiary_id
string

Filter by beneficiary ID

method
string

Filter by payment method (e.g., ach, sepa, swift)

status
enum<string>

Filter by instrument status

Available options:
active,
disabled

Search by label, bank, or last4

Response

200 - application/json

Paginated list of instruments

data
object[]
has_more
boolean