Balance
Your merchant balance is multi-currency. Every confirmed invoice credits the pay-in asset (net of the service fee) directly to that balance row. Withdraw on demand via the payouts endpoint.
GET /api/v1/merchant/balance
Required scope: balance.read.
json
{
"data": [
{
"asset": "USDT",
"chain": "tron",
"decimals": 6,
"available_raw": "82391545",
"locked_raw": "5000000",
"total_credited_raw": "120000000",
"total_debited_raw": "32608455",
"updated_at": "2026-05-16T11:34:56Z"
}
]
}available_raw— withdrawable now.locked_raw— reserved for in-flight payouts/refunds.total_credited_raw/total_debited_raw— lifetime totals.- All values are raw minor units. Use the asset's
decimalsfor display.
GET /api/v1/merchant/balance/ledger
Cursor-paginated append-only ledger. Every credit/debit/lock/unlock row references the underlying invoice / payout / refund. Each entry is hash-chained for tamper detection.
| Field | Notes |
|---|---|
direction | credit · debit · lock · unlock · adjustment |
reason | invoice_paid, payout_lock, payout_release_ok, payout_release_failed, refund_*, manual_adjustment, reorg_reversal |
reason_id | UUID of the source operation. |
available_after_raw | Available balance after this entry. |
locked_after_raw | Locked balance after this entry. |