List payment links
List payment links
Overview
List payment links
Returns payment links with optional filters for state and purpose.
When to use this
Use to audit which links are still active and their target amounts or products.
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-links
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 |
isActive | query | No | - | Filtrer par statut actif |
linkType | query | No | - | Filtrer par type de lien |
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-links?offset=1&limit=1" \
-H "X-API-KEY: $LOMI_SECRET_KEY"OpenAPI
- operationId:
PaymentLinksController_findAll - Operation:
GET /payment-links
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.