lomi.
Demandes de paiement

Créer une demande de paiement

Créer une demande de paiement

Aperçu

Créer une demande de paiement

Crée une demande de paiement pour un client. Elle a une date d’expiration et peut être suivie jusqu’à réussite ou expiration.

Quand l’utiliser

Utilisez pour des demandes « payez cette facture » ou POS où le payeur confirme sur son appareil.

Voir aussi

Récupérer une demande de paiement · Transactions

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

POST /payment-requests

URLs de base :

  • https://sandbox.api.lomi.africa
  • https://api.lomi.africa

Requête

Paramètres d’URL

Pas d’autre paramètre dans l’URL.

Paramètres de requête

Aucun paramètre de requête.

Corps de la requête

Corps JSON.

Schéma: object

ChampObligatoireTypeDescription
amountOuinumber-
currency_codeOuienum ("XOF", "USD", "EUR")-
descriptionNonstring-
customer_idNonstring-
expiry_dateOuistring-
payment_referenceNonstring-
metadataNonobject-

Exemple de corps :

{
  "amount": 0,
  "currency_code": "XOF",
  "expiry_date": "string"
}

Réponses

StatutDescription
201Demande de paiement créée avec succès
400Entrée invalide ou erreur de validation
401Clé 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 POST "https://sandbox.api.lomi.africa/payment-requests" \
  -H "X-API-KEY: $LOMI_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":0,"currency_code":"XOF","expiry_date":"string"}'

OpenAPI

  • operationId: PaymentRequestsController_create
  • Operation: POST /payment-requests

Schémas complets et Try it : référence API.

Sur cette page