v1

latestOpenAPI 3.0.02026-07-242444105.9 KB

Beneficiaries

List Beneficiaries

List all beneficiary bank accounts, custody accounts and wallet accounts.

get/v3/beneficiaries

Query parameters

limitnumber

Limit result set for server-side paging

pageTokennumber

Offset result set when paging

Response

Success

idinteger

counterparty_idinteger

aidstring

cidstring

account_typestring

ccystring

host_namestring

host_hubstring

host_locationstring

node_namestring

node_addressstring

node_locationstring

node_countrystring

node_subaddressstring

ibanstring

account_labelstring

descriptionstring

settlement_referencestring

created_atstring

updated_atstring

partner_idinteger

emailstring

pidstring

partner_namestring

Example response

[
  {
    "id": 378,
    "counterparty_id": 483,
    "aid": "A01-CX00000101",
    "cid": "CX00000101",
    "account_type": "Wallet",
    "ccy": "BTC",
    "host_name": "BCB Group",
    "node_name": "BCB Payments Ltd",
    "node_address": "3LxDswEWKC3mJewRYs44xr3qNBqXMwhszo",
    "account_label": "LNS 5 BTC hszo",
    "description": "BCB Payments Ltd, 3LxDswEWKC3mJewRYs44xr3qNBqXMwhszo, BTC",
    "created_at": "2018-12-28T14:42:44.000Z",
    "updated_at": "2019-01-24T21:26:27.000Z",
    "partner_id": 4,
    "email": "otc@bcbgroup.io",
    "pid": "P01061701",
    "partner_name": "BCB Direct"
  }
]