Webhook

Le Webhook (ou callback) de Digitalpaye permet de recevoir des notifications en temps réel concernant les transactions effectuées via votre plateforme. Lorsqu'une transaction est effectuée avec succès ou rencontre une erreur, Digitalpaye envoie une notification à l'URL que vous avez configurée comme webhook.

URL du Webhook

Vous devez fournir une URL de réception pour le webhook afin que Digitalpaye puisse envoyer les notifications de transaction. Assurez-vous que cette URL est accessible publiquement depuis Internet.

Exemple d'URL du Webhook :

https://votre-domaine.com/webhook

Format de la Notification (Payload)

Le webhook envoie des données au format JSON contenant les détails de la transaction. Voici un exemple du format de données que vous recevrez :

{
    "linkpayment_id": null,
    "ref": "RCI-DIGITALP-4884",
    "operator_id": "cos-1nrfn53g023ra",
    "transaction_id": "TICK-01210009010219",
    "cardId": null,
    "number_user": "2250777101308",
    "name_user": "GUEI HELIE",
    "email_user": null,
    "country_user": "CI",
    "currency": "XOF",
    "amount": "310",
    "fees": "6.2",
    "amount_receive": "303.8",
    "amount_total": "310",
    "status": "SUCCESSFULL",
    "type_transaction": "collecte",
    "type_payment": "WAVE_CI",
    "redirectUrl": null,
    "date": "2024-04-26 17:29:40",
    "date_update": "26/04/2024 16:59:29"
}

Description des Champs

• ref: Référence de la transaction.

• linkpayment_id: Identifiant du lien de paiement

• operator_id: Identifiant de l'opérateur.

• transaction_id: Identifiant de la transaction.

• cardId: Identifiant de la carte, si le paiement a été effectué par une carte Digitalpaye.

• number_user: Numéro de téléphone de l'utilisateur.

• name_user: Nom de l'utilisateur.

• email_user: Adresse e-mail de l'utilisateur.

• country_user: Pays de l'utilisateur.

• currency: Devise de la transaction.

• amount: Montant initial de la transaction.

• fees: Frais de la transaction.

• amount_receive: Montant reçu après déduction des frais.

• amount_total: Montant total de la transaction.

• status: Statut de la transaction (SUCCESSFUL pour réussie et FAILED pour échouée).

• type_transaction: Type de transaction (collecte, transfer, paiement, withdrawal, etc.).

• type_payment: Type de paiement utilisé (MTN_MONEY_CI, WAVE_CI, etc.).

• date: Date et heure de la transaction.

• date_update: Date et heure de la mise à jour de la transaction (le cas échéant).

Utilisation du Webhook

Pour utiliser le webhook de Digitalpaye, configurez l'URL de réception dans votre compte Digitalpaye. Une fois configuré, Digitalpaye enverra automatiquement les notifications de transaction à cette URL en temps réel.

Pour traiter ces notifications, vous pouvez créer un script ou un endpoint sur votre serveur web pour recevoir les données JSON et effectuer les actions nécessaires en fonction du statut et des détails de la transaction reçue.