WEBHOOK
/
webhook
/
payment-status
[
  {
    "transId": "<string>",
    "status": "CREATED",
    "medium": "mobile money",
    "serviceName": "<string>",
    "amount": 123,
    "revenue": 123,
    "payerName": "<string>",
    "email": "jsmith@example.com",
    "redirectUrl": "<string>",
    "externalId": "<string>",
    "userId": "<string>",
    "webhook": "<string>",
    "financialTransId": "<string>",
    "dateInitiated": "2023-12-25",
    "dateConfirmed": "2023-12-25"
  }
]

Un webhook est un point de terminaison API mis à disposition des applications externes, qui peut être appelé pour notifier votre application lorsqu’un événement important se produit. Cela permet à votre application de réagir immédiatement à ces événements.

Vous pouvez définir une URL de webhook par service dans votre tableau de bord Fapshi. Lorsqu’un webhook est défini, une requête POST sera envoyée à cette URL chaque fois que le statut d’un paiement change en :

  • SUCCESSFUL — lorsqu’un paiement est effectué avec succès
  • FAILED — lorsqu’une tentative de paiement échoue (généralement sur les réseaux MTN Mobile Money ou Orange Money)
  • EXPIRED — lorsqu’un lien de paiement expire après 24 heures sans paiement réussi

Le corps de la requête webhook est identique au corps de la réponse retournée par la requête de statut de paiement.

Votre serveur doit répondre rapidement aux requêtes webhook pour éviter les erreurs de timeout. Fapshi n’envoie qu’une seule requête webhook par événement, même si votre serveur ne répond pas.

Response

200
application/json

Accusé de réception du webhook

The response is of type object[].