Retrieve payment link
Retrieve payment link
Overview
Retrieve payment link
Returns URLs, visibility, and status for a single link.
When to use this
Use before resharing a link or embedding it in messaging.
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/{id}
Base URLs:
https://sandbox.api.lomi.africahttps://api.lomi.africa
Request
Path parameters
| Name | Required | Schema | Description |
|---|---|---|---|
id | Yes | - | UUID du lien de paiement |
Query parameters
No query parameters.
Responses
| Status | Description |
|---|---|
200 | Success |
401 | Invalid or missing API key |
404 | Resource not found |
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/value" \
-H "X-API-KEY: $LOMI_SECRET_KEY"OpenAPI
- operationId:
PaymentLinksController_findOne - Operation:
GET /payment-links/{id}
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.