Check available balance

Overview

Check available balance

Checks whether sufficient funds exist in the requested currency before you move money out or reserve balance.

When to use this

Call before initiating a payout, beneficiary payout, or any flow where you must guarantee spendable balance.

See also

Account balances · Payouts

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/check/{currency}

Base URLs:

• https://sandbox.api.lomi.africa
• https://api.lomi.africa

Request

Path parameters

No path parameters beyond the URL pattern.

Query parameters

No query parameters.

Responses

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/check/currency_value" \
  -H "X-API-KEY: $LOMI_SECRET_KEY"

OpenAPI

• operationId: AccountsController_checkAvailableBalance
• Operation: GET /accounts/balance/check/{currency}

Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.