Webhooks et Evénements
Gestion des événements
Les événements sont des actions importantes qui se produisent dans votre compte FedaPay, comme la création d’une transaction ou la mise à jour d’un client. Comprendre comment fonctionnent ces événements vous permet de mieux gérer vos transactions et d’offrir une meilleure expérience à vos clients.
Chaque fois qu’un événement se produit, FedaPay le signale en temps réel via des notifications d’événements. Ces notifications peuvent être utilisées pour suivre et réagir à ce qui se passe dans votre compte, comme lorsqu’un paiement est approuvé ou un client est modifié.
Cycle de vie des transactions
Les transactions sur FedaPay suivent un cycle de vie, et chaque étape de ce cycle génère un événement particulier. Voici comment ça se passe :
-
Création de la transaction : Une fois que le client est créé, vous pouvez lui attribuer une transaction. Cela déclenche l’événement transaction.created.
-
Suivi des transactions : Une transaction peut évoluer de plusieurs façons :
-
transaction.approved : La transaction a été approuvée, ce qui signifie que le paiement a été validé.
-
transaction.declined : Le paiement a échoué ou a été refusé.
-
transaction.canceled : La transaction a été annulée avant sa finalisation.
-
transaction.transferred : Les fonds de la transaction ont été transférés au compte prévu (par exemple, vers un compte bancaire ou mobile money).
-
-
À chaque changement de statut, un nouvel événement est généré pour vous tenir informé. Par exemple, dès qu’une transaction est mise à jour, l’événement transaction.updated est déclenché.
Cycle de vie des clients
Les clients peuvent également faire l’objet d’événements spécifiques :
-
customer.updated : Le profil du client a été modifié (par exemple, son nom ou son adresse e-mail).
-
customer.deleted : Le client a été supprimé de votre compte.
Comment utiliser les événements ?
Chaque événement contient des informations détaillées sur ce qui vient de se passer. Vous pouvez consulter tous ces événements dans la section Événements de votre tableau de bord FedaPay. Cela vous permet d’avoir un historique complet de toutes les actions importantes sur votre compte.
Pourquoi est-ce important ?
La gestion des événements vous aide à :
-
Suivre vos paiements : Vous êtes informé en temps réel de l’état de chaque transaction.
-
Gérer vos clients : Vous pouvez suivre les modifications apportées aux profils de vos clients.
-
Automatiser vos processus : Grâce à la notification des événements, vous pouvez automatiser certaines tâches sur votre site, comme envoyer un e-mail de confirmation après un paiement réussi.
Introduction aux Webhooks
Les Webhooks sont des notifications automatiques que FedaPay envoie à votre application ou site web lorsque des événements importants se produisent sur votre compte. Par exemple, vous pouvez recevoir un webhook lorsqu’une transaction est réussie ou contestée.
Ces notifications sont particulièrement utiles car elles vous permettent de rester informé en temps réel, sans avoir à vérifier manuellement ce qui se passe sur votre compte FedaPay.
Pourquoi utiliser des Webhooks ?
Les Webhooks sont essentiels pour être alerté rapidement des actions importantes sur votre compte, comme :
-
Des paiements réussis ou échoués
-
Des remboursements
-
Des transactions contestées
Comment fonctionnent les Webhooks ?
Chaque fois qu’un événement se produit (par exemple, un paiement accepté), FedaPay crée un objet événement (Event). Cet objet contient toutes les informations pertinentes sur l’événement, comme le type d’événement (paiement réussi) et les détails associés.
Ensuite, FedaPay envoie cet objet à l’URL de votre choix (appelée point de terminaison) via une requête HTTP. C’est comme si FedaPay vous envoyait un message pour vous informer de ce qui s’est passé.
Configuration des Webhooks
Créer un Webhook
Pour recevoir des Webhooks, vous devez configurer une URL sur votre site qui pourra recevoir ces notifications. Voici comment faire :
-
Connectez-vous à votre compte FedaPay et accédez à la section Webhooks de votre tableau de bord.
-
Cliquez sur Créer un Webhook.
-
Entrez l’URL de votre site où vous souhaitez recevoir les notifications. Il est important que cette page soit prête à recevoir des notifications de FedaPay.
-
Sélectionnez les types d’événements pour lesquels vous voulez être notifié (par exemple : paiements réussis, remboursements).
-
Cliquez sur Créer.
Gérer vos Webhooks
Une fois vos Webhooks créés, vous pouvez :
-
Modifier : Changez l’URL ou les événements que vous souhaitez suivre.
-
Supprimer : Si vous n’avez plus besoin de ce Webhook, vous pouvez le supprimer.
-
Consulter les détails : Vous pouvez voir toutes les informations sur le Webhook en question (URL, événements suivis, etc.).
Vérification des signatures des Webhooks
Pour garantir que les notifications que vous recevez proviennent bien de FedaPay (et non d’une tierce partie), FedaPay signe chaque événement envoyé à votre URL.
Comment vérifier la signature ?
-
Lorsqu’un Webhook est envoyé, FedaPay inclut une signature dans l’en-tête de la requête. Cette signature est nommée X-FEDAPAY-SIGNATURE.
-
Pour vérifier que le message est authentique, vous devez utiliser la clé secrète de votre Webhook. Vous pouvez la récupérer dans les paramètres de votre tableau de bord.
-
Utilisez cette clé secrète pour vérifier la signature et vous assurer que le Webhook a bien été envoyé par FedaPay.
Outils pour vérifier les signatures
Nous vous recommandons d’utiliser les bibliothèques officielles de FedaPay (disponibles en PHP, Node.js, etc.) pour faciliter la vérification des signatures. Ces bibliothèques font le travail pour vous et vous signalent immédiatement si la signature n’est pas correcte.
Les Webhooks sont un moyen pratique et efficace de rester informé des événements importants sur votre compte FedaPay. En les configurant correctement, vous pouvez automatiser vos actions et suivre de près toutes les transactions effectuées via votre plateforme.
N’oubliez pas de vérifier la signature des Webhooks pour garantir leur sécurité et authenticité.