Endpoint
Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | Your API key |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
currency | string | No | NGN | Currency code (e.g., NGN, USD) |
Request example
Response
| Field | Type | Description |
|---|---|---|
balance | number | Current book balance |
ledgerBalance | number | Total ledger balance including pending transactions |
totalHolds | number | Amount currently held (e.g., pending approvals) |
availableBalance | number | Balance available for transactions (balance - totalHolds) |
currency | string | Currency of the balance |