Balance breakdown
Balance breakdown
Overview
Balance breakdown
Returns balance components (available, pending, totals) and may convert amounts into a target currency for reporting.
When to use this
Use when finance or support teams need a split between pending and available, not just a single number.
Authentication
Merchant routes require an API key in the X-API-KEY header (see Integration overview). Use a test key against https://sandbox.api.lomi.africa and a live key against https://api.lomi.africa.
Endpoint
GET /accounts/balance/breakdown
Base URLs:
https://sandbox.api.lomi.africahttps://api.lomi.africa
Request
Path parameters
No path parameters beyond the URL pattern.
Query parameters
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
target_currency | query | No | - | Devise cible pour la conversion (XOF, USD, EUR) |
Responses
| Status | Description |
|---|---|
200 | Success |
Errors
Errors follow the standard JSON error format (status code and machine-readable message). Validate inputs before calling; 401 indicates a missing/invalid key, 404 a missing resource for this organization, 429 rate limiting. For safe retries on create-style calls, send an idempotency key when your flow supports it.
Example
curl -sS -X GET "https://sandbox.api.lomi.africa/accounts/balance/breakdown?target_currency=XOF" \
-H "X-API-KEY: $LOMI_SECRET_KEY"OpenAPI
- operationId:
AccountsController_getBalanceBreakdown - Operation:
GET /accounts/balance/breakdown
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.