Accounts — payments-api

Accounts

List Accounts

get/v3/accounts

Query parameters

counterparty_idinteger

Limit accounts by Counterparty ID

idinteger

Limit result set to a specific Account ID

limitinteger

Limit result set for server-side paging

pageTokeninteger

Offset result set when paging

Response

Success

idinteger required

Account ID

counterparty_idinteger required

Counterparty ID

aidstring

Alpha-numeric account ID

cidstring

Alpha-numeric counterparty ID

account_type'Bank' | 'Custodial' | 'Wallet'

ccystring

Asset ticker, or left hand side of trading symbol

host_namestring

Bank Name for bank accounts, Custodian Name for custody accounts, Wallet Name for wallet accounts

host_hubstring

Branch Code for bank accounts, optional for custody and wallets

host_locationstring

node_namestring

Account holder's legal name

node_addressstring

Account Number for bank accounts, wallet address for wallets, optional for custody

node_locationstring

Account holder's residential address for bank accounts, optional memo field for custody and wallets

node_countrystring

Account holder's residential address country code (2-letter ISO country code), optional memo field for custody and wallets

ibanstring

IBAN for bank accounts

account_labelstring

Display name for account

descriptionstring

Free-text description of account

bcb_controlledstring

Flag is 1 if BCB can operate the account, 0 otherwise

settlement_referencestring

Optional settlement reference for payments

created_atstring

Timestamp of account record creation (YYYY-MM-DDTHH:MM:SS.000Z)

updated_atstring

Timestamp of account record update (YYYY-MM-DDTHH:MM:SS.000Z)

blinc_idstring

Only applicable to BLINC accounts - account id within BLINC network

partner_idstring

This field is deprecated.

emailstring

Email address of client

reporting_ccystring

Home currency of client

pidstring

This field is deprecated.

partner_namestring

This field is deprecated.