Reading account

GET /api/public/v1/accounts/:id

Returns a single account by ID, including its balance and the networks available for receiving deposits.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

Path Parameters

Name	Type	Description
id	string	Account ID.

Response

HTTP 200 (crypto account)

{
  "data": {
    "id": "e289de2b-37bd-4eff-b832-f754c31a2d95",
    "type": "accounts",
    "attributes": {
      "master": true,
      "currencyCode": "USDT",
      "label": "master",
      "bankReference": "BDR4180381621673581",
      "balance": "344086.455299",
      "totalBalance": "344219.499753",
      "bankWithdrawalAvailable": false,
      "bankDepositAvailable": false,
      "transferAvailable": true,
      "currencyType": "crypto"
    },
    "relationships": {
      "company": {
        "meta": {
          "included": false
        }
      },
      "networks": {
        "data": [
          {
            "type": "network",
            "id": "2cfea86d-f334-4bd2-99ac-e74281520c95"
          },
          {
            "type": "network",
            "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2"
          },
          {
            "type": "network",
            "id": "490f02d4-b09a-4486-a469-d10c2ea43638"
          },
          {
            "type": "network",
            "id": "927d49d4-f4b2-48dc-876d-ac375337ec2a"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "2cfea86d-f334-4bd2-99ac-e74281520c95",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Ethereum (ERC20)",
        "code": "hterc6dp"
      }
    },
    {
      "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Tron (TRC20)",
        "code": "ttrx:usdt"
      }
    },
    {
      "id": "490f02d4-b09a-4486-a469-d10c2ea43638",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Polygon (ERC20)",
        "code": "tpolygon:usdt"
      }
    },
    {
      "id": "927d49d4-f4b2-48dc-876d-ac375337ec2a",
      "type": "network",
      "attributes": {
        "currencyCode": "USDT",
        "name": "Binance Smart Chain (BEP20)",
        "code": "tbsc:usdt"
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

HTTP 200 (fiat account)

{
  "data": {
    "id": "1b67dc40-4fd9-4318-9329-c9afb3ed8a15",
    "type": "accounts",
    "attributes": {
      "master": false,
      "currencyCode": "EUR",
      "label": "EUR_1",
      "bankReference": "BDR0154632342411086",
      "balance": "120.50",
      "totalBalance": "120.50",
      "bankWithdrawalAvailable": true,
      "bankDepositAvailable": true,
      "transferAvailable": true,
      "currencyType": "fiat"
    },
    "relationships": {
      "company": {
        "meta": {
          "included": false
        }
      },
      "networks": {
        "data": []
      },
      "txnBankCredentials": {
        "data": [
          {
            "type": "txnBankCredential",
            "id": "3808e047-3479-4ba9-88dc-31729b4666d5"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "3808e047-3479-4ba9-88dc-31729b4666d5",
      "type": "txnBankCredential",
      "attributes": {
        "currencyCode": "EUR",
        "beneficiaryName": "Acme Commerce Ltd",
        "iban": "DE89370400440532013000",
        "bic": "COBADEFFXXX",
        "bankName": "Commerzbank",
        "bankAddress": "Kaiserplatz, 60311 Frankfurt am Main, Germany"
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

Response Body

Name	Type	Description
data.id	string	Account ID.
data.type	string	Entity type returned. Always accounts.
data.attributes	object	A set of account attributes.
data.attributes.master	boolean	If true, account is master. If false, account is subaccount.
data.attributes.bankReference	string	Unique bank deposit reference for each account and subaccount. Example: BDR6421088115176062.
data.attributes.label	string	Account label.
data.attributes.currencyCode	string	Account currency code. Refer to the list of supported currencies.
data.attributes.balance	string	Account balance. Returned as a string for decimal precision.
data.attributes.totalBalance	string	For master accounts only. Total balance across the master account and its subaccounts.
data.attributes.bankWithdrawalAvailable	boolean	If true, bank withdrawals can be initiated from this account. If false, they are restricted.
data.attributes.bankDepositAvailable	boolean	If true, the account can receive bank deposits.
data.attributes.transferAvailable	boolean	If true, the account can send and receive internal transfers.
data.attributes.currencyType	string	Account currency type. Either fiat or crypto.
data.relationships.txnBankCredentials.data[].type	string	Entity type of a linked bank credential. Always txnBankCredential.
data.relationships.txnBankCredentials.data[].id	string	ID of a linked bank credential, expanded under included. Populated for fiat accounts and empty for crypto accounts.
included[].type(network).id	string	Network ID. Use this as network_id when creating an account address. Present for crypto accounts.
included[].type(network).attributes.currencyCode	string	Network currency code. Useful for display to end users.
included[].type(network).attributes.name	string	Human-readable network name, e.g. Tron (TRC20). Useful for display to end users.
included[].type(network).attributes.code	string	Network code, e.g. ttrx:usdt. See Supported currencies.
included[].type(txnBankCredential).attributes	object	Bank deposit credentials for a fiat account. Use these details to fund the account by bank transfer.
included[].type(txnBankCredential).attributes.currencyCode	string	Currency of the bank credential.
included[].type(txnBankCredential).attributes.beneficiaryName	string	Name of the beneficiary on the bank account.
included[].type(txnBankCredential).attributes.iban	string	Beneficiary IBAN.
included[].type(txnBankCredential).attributes.bic	string	Beneficiary bank BIC/SWIFT code.
included[].type(txnBankCredential).attributes.bankName	string	Name of the beneficiary's bank.
included[].type(txnBankCredential).attributes.bankAddress	string	Address of the beneficiary's bank.