Aller au contenu principal

Payment Intents

Un PaymentIntent représente un flux de paiement. Il suit le cycle de vie depuis la création jusqu’à la finalisation.

Famille de routes actuellement implémentée : payment_intents

Objet PaymentIntent

{
"id": "pi_1a2b3c4d5e",
"object": "payment_intent",
"amount": 10000,
"currency": "xof",
"status": "requires_payment_method",
"payment_method_types": ["mobile_money", "card"],
"description": "Order #1234",
"metadata": {},
"created": 1708300800
}

Créer un PaymentIntent

POST /payment_intents
ParamètreTypeRequisDescription
amountintegerMontant dans la plus petite unité monétaire
currencystringCode devise ISO à trois lettres
payment_method_typesstring[]Méthodes de paiement autorisées
descriptionstringDescription du paiement
metadataobjectMétadonnées clé-valeur
confirmbooleanConfirme immédiatement si vrai
customerstringIdentifiant client
payment_methodstringIdentifiant de méthode de paiement

Récupérer un PaymentIntent

GET /payment_intents/{id}

Mettre à jour un PaymentIntent

PATCH /payment_intents/{id}

Confirmer un PaymentIntent

POST /payment_intents/{id}/confirm
ParamètreTypeRequisDescription
payment_methodstringIdentifiant de méthode de paiement
payment_method_dataobjectDonnées inline de méthode de paiement

Annuler un PaymentIntent

POST /payment_intents/{id}/cancel

Lister les PaymentIntents

GET /payment_intents
ParamètreTypeDescription
limitintegerNombre de résultats demandés