TAtatum
Account

List all customer accounts

/v3/ledger/account/customer/{id}

1 credit per API call.

Lists all accounts associated with a customer. Only active accounts are visible.

get/v3/ledger/account/customer/{id}

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/ledger/account/customer/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required
Example:5e68c66581f2ee32bc354087

Internal customer ID

Query parameters

pageSizenumber required
Example:10

Max number of items per page is 50.

offsetnumber

Offset to obtain the next page of data.

accountCodestring
Example:AC_1011_B

For bookkeeping to distinct account purpose.

Response

OK

idstring required

The ID of the virtual account

currencystring required

The currency of the virtual account

frozenboolean required

If set to "true", the virtual account is frozen

activeboolean required

If set to "true", the virtual account is active

customerIdstring

The ID of the customer (newly created or existing one) associated with the virtual account

accountNumberstring

The number associated with the virtual account in an external system

accountCodestring

The code associated with the virtual account in an external system to designate the purpose of the account in bookkeeping

accountingCurrencystring

The currency in which all the transactions for all accounts will be accounted

xpubstring

The extended public key of the blockchain wallet associated with the virtual account; used to generate deposit addresses for the virtual account

Example response

[
  {
    "id": "5e68c66581f2ee32bc354087",
    "balance": {
      "accountBalance": "1000000",
      "availableBalance": "1000000"
    },
    "currency": "BTC",
    "active": true,
    "customerId": "5e68c66581f2ee32bc354087",
    "accountNumber": "123456",
    "accountCode": "03_ACC_01",
    "accountingCurrency": "EUR",
    "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.