Skip to main content
GET
/
v1
/
beneficiaries
List beneficiaries
curl --request GET \
  --url http://localhost:8080/v1/beneficiaries \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "ben_cq1234567890abcdef",
      "merchant_id": "<string>",
      "type": "individual",
      "status": "pending",
      "first_name": "<string>",
      "last_name": "<string>",
      "company_name": "<string>",
      "email": "[email protected]",
      "phone": "<string>",
      "country": "<string>",
      "bank_name": "<string>",
      "account_number": "<string>",
      "iban": "<string>",
      "swift_bic": "<string>",
      "wallet_address": "<string>",
      "wallet_network": "<string>",
      "token_contract": "<string>",
      "token_symbol": "<string>",
      "address_verified": true,
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "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

Response

200 - application/json

Paginated list of beneficiaries

data
object[]
pagination
object