List settlement periods
List settlement periods
Overview
List settlement periods
Returns completed payment totals grouped by availability date (UTC) and currency. Each settlement_id uses {currency}:{YYYY-MM-DD}.
When to use this
Use for accounting reconciliation before requesting payouts or exporting withdrawable totals by day.
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 /settlements
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 |
|---|---|---|---|---|
pageSize | query | No | - | |
page | query | No | - | |
currency | query | No | - | |
end_date | query | No | - | |
start_date | query | No | - |
Responses
| Status | Description |
|---|---|
200 | Settlement periods |
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/settlements?pageSize=1&page=1" \
-H "X-API-KEY: $LOMI_SECRET_KEY"OpenAPI
- operationId:
SettlementsController_findAll - Operation:
GET /settlements
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.