Lister les liens de paiement
Lister les liens de paiement
Aperçu
Lister les liens de paiement
Renvoie tous les liens de l'organisation avec pagination et filtres optionnels (type, actif).
Quand l’utiliser
Utilisez cet endpoint quand vous devez exécuter GET /payment-links (Lister les liens de paiement).
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 /payment-links
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 |
|---|---|---|---|---|
offset | query | Non | - | Décalage pour la pagination |
limit | query | Non | - | Nombre maximal de résultats |
isActive | query | Non | - | Filtrer par statut actif |
linkType | query | Non | - | Filtrer par type de lien |
Réponses
| Statut | Description |
|---|---|
200 | Liste paginée de liens de paiement |
401 | Clé API invalide ou manquante |
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/payment-links?offset=1&limit=1" \
-H "X-API-KEY: $LOMI_SECRET_KEY"OpenAPI
- operationId:
PaymentLinksController_findAll - Operation:
GET /payment-links
Schémas complets et Try it : référence API.