Balances
Merchant balances
Understand available and pending stablecoin balances across supported networks.
Merchant balances are read-only API projections of funds owned by the authenticated merchant account. Every record is isolated by chain and currency and separates available funds from amounts that are still pending or reserved by another operation.
These are not customer balances. Do not combine records across chains or currencies when making an accounting or payout decision.
API Endpoints
- Get Balance: Retrieves the balance details for a specific account and currency.
- List Balances: Returns a list of all balances associated with an account across chains and currencies.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/balances/:id | Retrieve one account-owned balance. |
GET | /api/v1/balances | List non-zero balances, optionally filtered by chain and currency. |
Attributes
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the balance (e.g., bal_5). |
account_id | string | ID of the account associated with the balance. |
chain | string | Blockchain chain used (e.g., base). |
currency | string | Currency of the balance (e.g., USDC). |
available_balance | string | The amount of funds available for use (e.g., 1052.6). |
pending_balance | string | The amount of funds pending (e.g., 0.0). |
reserved_balance | string | Funds reserved by an in-progress payout or other debit, when returned. |
total_balance | string | Total represented by the balance record, when returned. |
created_at | timestamp | Time when the balance record was created. |
updated_at | timestamp | Time when the balance record was last updated. |
Amounts are decimal strings. Use Balance Transactions to explain movements rather than inferring them from two balance snapshots.
Did this page answer your question?
Your feedback helps us improve the integration path.