RÉFÉRENCE API · PAIEMENTS

Créer un paiement

POST/v1/payments

Crée un paiement et renvoie checkoutUrl, la page Yóbbal PAY à ouvrir chez le client. Sans provider, le client choisit lui-même Wave ou Orange Money.

Origine TEST : https://api.sandbox.pay.yobbal.com

En-têtes

AuthorizationBearer ypk_…OBLIGATOIRE

Votre clé API. Le préfixe ypk_test_ ou ypk_live_ doit correspondre à l’origine API choisie.

Idempotency-Keystring · 16 à 128 caractèresOBLIGATOIRE

Identifie la tentative. Réutilisez-la pour relancer la même demande ; la réponse est rejouée pendant 24 h.

amountinteger · min. 1 · max. 1 000 000OBLIGATOIRE

Montant en francs CFA, entier positif, au plus 1 000 000. Les frais de 1 % s’ajoutent si le client les paie.

currency"XOF"OBLIGATOIRE

Seule devise acceptée.

providerstringFACULTATIF

Impose l’opérateur. Omettez le champ pour laisser le choix au client ; n’envoyez pas null.

merchantReferencestringOBLIGATOIRE

Votre référence de commande, unique par marchand et environnement.

returnUrluriFACULTATIF

Page de retour après le paiement. HTTPS obligatoire en LIVE. Le retour ne vaut pas confirmation.

metadataobject · 20 clés maxFACULTATIF

Vos données libres, renvoyées dans le paiement et les webhooks.

201

Paiement TEST créé ou réponse rejouée

400

Demande invalide

403

Clé TEST requise

409

Référence marchand déjà utilisée ou demande en cours

422

Conflit d'idempotence