List payment requests
List payment requests
Overview
List payment requests
Returns a paginated ledger of requests with optional filters for status or references.
When to use this
Use for finance teams tracking outstanding requests.
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 /payment-requests
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 |
|---|---|---|---|---|
offset | query | No | - | Décalage pour la pagination |
limit | query | No | - | Nombre maximal de résultats |
customerId | query | No | - | Filtrer par ID client |
status | query | No | - | Filtrer par statut |
Responses
| Status | Description |
|---|---|
200 | Success |
401 | Invalid or missing API key |
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/payment-requests?offset=1&limit=1" \
-H "X-API-KEY: $LOMI_SECRET_KEY"OpenAPI
- operationId:
PaymentRequestsController_findAll - Operation:
GET /payment-requests
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.