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.
Get Wallet Sample response
A unique identifier automatically assigned to the wallet for referencing in APIs and internal systems.
Timestamp marking when the wallet was initially created in the system.
Timestamp indicating the last time the wallet record was updated.
A human-readable name assigned to the wallet for easier identification.
The unique ID of the company or organization that owns the wallet.
Indicates whether the wallet is currently active and operational.
The currency held in the wallet, such as 'btc' for Bitcoin or 'usd' for U.S. Dollars.
Specifies the wallet type, e.g., 'bitcoin' for crypto or 'fiat' for traditional currency.
A unique identifier assigned to the wallet, used for referencing and processing wallet-related transactions.
A nested object that contains detailed breakdowns of the wallet's available, pending, and total (ledger) balances.
Funds that are immediately available for use or withdrawal. This balance reflects cleared and confirmed funds.
Funds that are pending confirmation or settlement, such as unconfirmed crypto transactions.
The total balance, calculated as the sum of available and pending funds. Used for accounting and reconciliation.
The U.S. Dollar equivalent of the wallet's balance. Found under available, pending, or ledger.
Bitcoin value representation of the balance (applies to crypto wallets).
Balance in satoshis (smallest unit of Bitcoin).
Subunit of fiat currency (1 USD = 100 cents). Useful for precise fiat accounting.
Wallet Response Object Schema
An updated balance object schema to support more detailed financial tracking by including:
available: Funds that can be used immediately.
pending: Funds in transit (e.g., unconfirmed BTC or settlement in fiat).
ledger: Total funds (available + pending), often used for record-keeping.
Balance Object Schema (Nested)
Unique identifier for the wallet. This is a system-generated universally unique ID used to reference the wallet across operations.
Date and time the wallet was created, formatted in ISO 8601. This is useful for tracking when the wallet record was initiated.
Date and time of the last wallet update, helpful for auditing changes or modifications to the wallet metadata.
Human-readable name of the wallet. This label helps distinguish wallets easily in user interfaces and dashboards.
The UUID of the company or organization that owns the wallet. Used for associating the wallet with a business entity.
Type of currency the wallet holds. Indicates whether the wallet stores cryptocurrency (e.g., BTC) or fiat (e.g., USD).
Internal destination account ID or wallet number. Typically a 10-digit string used to identify the wallet in internal transfers.
Specifies the asset type this wallet is configured for. Common values include crypto assets like BTC, USDT, and USDC.
An object containing the current balance breakdown of the wallet, including available, pending, and ledger totals across different units (e.g., sat, btc, usd).
For Bitcoin Wallets ( assetType: bitcoin)
Represents the portion of Bitcoin (BTC) funds that are fully confirmed on the blockchain and immediately available for use. These funds can be used for transactions, withdrawals, or transfers without restriction.
Contains BTC amounts that have been sent or received but are still waiting for blockchain confirmations. Pending balances cannot be spent or transferred until the required number of confirmations is achieved.
The total BTC balance in the wallet, calculated as the sum of `available` and `pending` amounts. This reflects the complete wallet value including both confirmed and unconfirmed BTC.
For Fiat Wallets ( assetType: fiat)
Represents the portion of fiat funds (e.g., USD, GHS) that are immediately accessible for transactions such as payments, transfers, or withdrawals. These funds have cleared all processing stages and are not subject to any holds or verification delays.
Includes fiat funds that are currently undergoing settlement, processing, or verification. Examples include bank deposits that haven't cleared or card payments awaiting confirmation. These funds are not yet available for use.
Reflects the total fiat balance in the wallet, calculated as the sum of `available` and `pending`. It provides a complete view of all funds, whether cleared or still processing.
Each of these objects includes:
Represents the balance in U.S. Dollars (USD). This value is typically used for fiat wallets or as a converted equivalent of crypto balances based on current exchange rates. It is shown with decimal precision and used for financial calculations, reporting, and user display.