POST
/
initiate-pay
Générer un Lien de Paiement
curl --request POST \
  --url https://sandbox.fapshi.com/initiate-pay \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'apiuser: <api-key>' \
  --data '{
  "amount": 101,
  "email": "jsmith@example.com",
  "redirectUrl": "<string>",
  "userId": "<string>",
  "externalId": "<string>",
  "message": "<string>"
}'
{
  "message": "<string>",
  "link": "<string>",
  "transId": "<string>",
  "dateInitiated": "2023-12-25"
}

​
Endpoint

POST /initiate-pay

Générez un lien de paiement où les utilisateurs pourront compléter leur paiement sur une page de paiement préconstruite par Fapshi.

​
Paramètres

NomObligatoireTypeDescription
amountOuientierMontant à payer (minimum 100 XAF).
emailNonchaîneSi renseigné, l’utilisateur n’aura pas à fournir son email lors du paiement.
redirectUrlNonchaîneURL vers laquelle l’utilisateur sera redirigé après le paiement.
userIdNonchaîneID utilisateur interne (1-100 caractères ; a-z, A-Z, 0-9, -, _).
externalIdNonchaîneID de transaction/commande pour réconciliation (1-100 caractères ; a-z, A-Z, 0-9, -, _).
messageNonchaîneRaison du paiement.

​
Réponse

  • 200 OK avec un corps JSON contenant :

    • message : message de succès
    • link : URL où l’utilisateur doit effectuer le paiement
    • transId : ID de la transaction pour suivre le statut du paiement
    • dateInitiated : date de début du paiement

  • En cas d’erreur, retournera un code 4XX avec un message expliquant l’échec.

Les liens de paiement expirent au bout de 24 heures et ne peuvent plus être utilisés après cette période.

Authorizations

​
apiuser
string
header
required
​
apikey
string
header
required

Body

application/json

Response

200
application/json

Lien de paiement généré avec succès

The response is of type object.