Wallets

The Wallets API allows you to manage digital wallets linked to users or companies. It supports creating, retrieving, and organizing wallet data across different asset types and blockchain networks. Use this API to track balances, transactions, and wallet configurations securely and efficiently.

Wallet Endpoint

Get Balances

Use Case

This endpoint retrieves your account balances across all supported currencies. It provides real-time visibility into your available funds, making it useful for dashboards and ensuring sufficient funds before initiating transactions.

Get Balances

Get Balances Response

This is the standard shape of a balances response returned by the API.

1
successBoolean

Indicates whether the API request was successful.

2
messageString

A human-readable message describing the result of the request.

3
company_idUUID

The unique identifier of the company whose balances are being retrieved.

4
accountsArray

A list of account objects, each representing a balance for a specific currency.

5
account_idUUID

A unique identifier for the currency-specific account.

6
account_numberString

The company account number shared across all currency accounts.

7
currencyString

The currency of the account (e.g., USDT, USDC, BTC).

8
ledger_balanceString

The total balance recorded on the ledger. Values are fixed to 6 decimal places for stablecoins (USDT, USDC) and 8 decimal places for BTC.

9
available_balanceString

The balance available for use. Uses the same decimal precision rules as ledger_balance (6 decimals for stablecoins, 8 for BTC).

10
ledger_balance_formattedString

A human-readable version of the ledger balance including the currency symbol.

11
available_balance_formattedString

A human-readable version of the available balance including the currency symbol.

12
created_atDate

The ISO 8601 timestamp indicating when the account was created.

13
request_idString

A unique identifier for this API request, useful for debugging and support.

14
timestampDate

The ISO 8601 timestamp showing when the response was generated.

Balances Sample Response

Get Balance By Currency

Use Case

This endpoint retrieves your account balance for a specific currency. Use it to check available funds in a particular wallet (e.g., BTC, USD, USDT) before initiating transfers or for currency-specific reporting.

Path Parameters
1
:currencystringRequired

The currency code to retrieve the balance for (e.g., 'BTC', 'USDT', 'USDC').

Get Balance By Currency

Get Balance By Currency Response

This is the standard shape of a single currency balance response returned by the API.

1
successBoolean

Indicates whether the API request was successful.

2
messageString

A human-readable message describing the result of the request.

3
account_numberString

The account number associated with your company.

4
currencyString

The currency code for this balance (e.g., 'USDT', 'USDC', 'BTC').

5
total_balanceString

The total balance in the account, including pending amounts.

6
available_balanceString

The balance available for immediate use (total minus pending).

7
pending_balanceString

The amount currently held in pending transactions.

8
as_ofDate

The timestamp (ISO 8601 format) indicating when this balance snapshot was taken.

9
company_idUUID

The unique identifier of the company whose balance is being retrieved.

10
request_idString

A unique identifier for this specific API request, useful for debugging and support.

11
timestampDate

The timestamp (ISO 8601 format) when the response was generated.

Balance By Currency Sample Response
Did you find this page useful?