Get merchant balance
Get merchant balance
Overview
Get merchant balance
Returns account balance for a merchant in the requested currency.
When to use this
Use when a merchant ID is the scope key for wallet or treasury displays.
Good to know
Requires currency_code (XOF, USD, or EUR).
See also
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 /merchants/{id}/balance
Base URLs:
https://sandbox.api.lomi.africahttps://api.lomi.africa
Request
Path parameters
| Name | Required | Schema | Description |
|---|---|---|---|
id | Yes | - | Merchant UUID |
Query parameters
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
currency_code | query | Yes | - |
Responses
| Status | Description |
|---|---|
200 | Success |
400 | Missing currency_code |
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/merchants/value/balance?currency_code=XOF" \
-H "X-API-KEY: $LOMI_SECRET_KEY"OpenAPI
- operationId:
MerchantsController_getBalance - Operation:
GET /merchants/{id}/balance
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.