List settlement periods
List settlement periods
Aperçu
List settlement periods
Returns completed payment totals grouped by availability date and currency. Each settlement_id is {currency}:{YYYY-MM-DD} (UTC date of available_at).
Quand l’utiliser
Utilisez cet endpoint quand vous devez exécuter GET /settlements (List settlement periods).
Authentification
Les routes marchandes nécessitent une clé API dans l’en-tête X-API-KEY (voir Vue d’ensemble). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.
Endpoint
GET /settlements
URLs de base :
https://sandbox.api.lomi.africahttps://api.lomi.africa
Requête
Paramètres d’URL
Pas d’autre paramètre dans l’URL.
Paramètres de requête
| Nom | Emplacement | Obligatoire | Schéma | Description |
|---|---|---|---|---|
pageSize | query | Non | - | |
page | query | Non | - | |
currency | query | Non | - | |
end_date | query | Non | - | |
start_date | query | Non | - |
Réponses
| Statut | Description |
|---|---|
200 | Settlement periods |
Erreurs
Les erreurs suivent un format JSON standard. 401 : clé manquante ou invalide. 404 : ressource introuvable. 429 : trop de requêtes. Pour les créations, envoyez une clé d’idempotence si votre flux le permet.
Exemple
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
Schémas complets et Try it : référence API.