Références API

/payment

POST

Crée une demande de signature pour un paiement.

Lance une demande de signature d’un paiement. L’application affiche le montant et le bénéficiaire de façon structurée, ce qui évite toute ambiguïté sur ce que l’utilisateur autorise. Utilisez la méthode /collect pour connaître l’état de la demande.

Corps de la requête

application/json
endUserIp chaîne Obligatoire

L’adresse IP de l’utilisateur, telle que votre service la voit (voir /auth).

transaction objet Obligatoire

Les données du paiement, affichées à l’utilisateur.

amount (chaîne, obligatoire) : le montant, en chiffres, avec un point décimal si besoin. currency (chaîne, obligatoire) : le code de la devise, par exemple XOF. recipient (objet, obligatoire) : name (nom du bénéficiaire) et account (compte ou numéro de téléphone, tel qu’il doit être affiché). reference (chaîne) : le libellé ou la référence du paiement.

userVisibleData chaîne

Texte supplémentaire affiché sous le paiement, en Base64. 1 500 caractères au plus.

userNonVisibleData chaîne

Données de votre choix en Base64, non montrées à la personne. Elles vous sont renvoyées dans completionData.

returnUrl, returnRisk, requirement, app, web

Identiques à ceux de /auth.

Exemple

{
  "endUserIp": "196.28.245.10",
  "transaction": {
    "amount": "450000",
    "currency": "XOF",
    "recipient": { "name": "R. Kaboré", "account": "22670112233" },
    "reference": "Loyer de novembre"
  },
  "requirement": { "personalNumber": "B1234567" },
  "returnRisk": true
}

Le texte signé contient les données du paiement : le montant, la devise, le bénéficiaire et la référence font partie de la preuve.

Réponses

200 · Requête réussie

La réponse est identique à celle de /auth : orderRef, autoStartToken, qrStartToken, qrStartSecret. Les erreurs sont décrites dans Erreurs.