Configurer les webhooks
Les notifications instantanées et en temps réel de Paysafe sont des webhooks qui vous informent de toutes les mises à jour d’état. Un webhook est un rappel HTTP déclenché lorsqu’un événement se produit. Vous pouvez spécifier l’URL de destination sous la forme d’une requête HTTP lors de la création d’un webhook. Les notifications sont envoyées à cette URL sur votre serveur en fonction de l’occurrence des événements.
Pourquoi utiliser des webhooks?
Vous pouvez utiliser les webhooks chaque fois que vous souhaitez connaître des événements et agir en fonction de ceux-ci. Vous pouvez configurer votre abonnement au webhook pour des événements comme un paiement échoué, un paiement annulé, et ainsi de suite, et faire en sorte que vous soyez notifié de ces événements. Pour une liste détaillée des événements de webhook pris en charge, voir la section « Liste des événements et des sujets pris en charge par le webhook ».
Informations sur la requête de webhook
Lorsque vous configurez votre abonnement aux webhooks, les événements sont créés et envoyés de manière asynchrone au fur et à mesure qu’ils se produisent. Les messages de notification Paysafe sont des requêtes POST qui contiennent les données utiles codées en JSON avec les en-têtes HTTP. Vous devez utiliser les deux – l’en-tête et la chaîne JSON – pour utiliser un webhook. Ces données utiles contiennent un minimum de détails sur l’événement déclenché. Paysafe renvoie des liens vers la ressource API correspondante. Vous pouvez l’utiliser pour trouver des informations détaillées sur une ressource dont l’état a changé. Pour configurer les webhooks, ouvrez une demande de service dans le portail d’entreprise.
En-têtes de webhook
Les en-têtes de webhook sont utiles lors de la transmission d’une requête de webhook. Parmi les nombreux en-têtes HTTP, Paysafe inclut également un en-tête de signature de webhook que vous pouvez utiliser pour vérifier le Webhook.
Signature de webhook
La notification du webhook comporte un en-tête de signature calculé à l’aide de l’algorithme suivant :
digest = HMAC_SHA256 (hmacKey, UTF 8 string containing the JSON webhook request body)
signature = base 64 (digest)
Le code qui reçoit le webhook doit répéter cet algorithme et comparer la valeur générée avec la valeur reçue dans l’en-tête.
Exemple d’en-tête :
Signature : UMaQ4h635wUc4hp60Z5ASBC/5UtqKybAldOkLv6ngc0=
Données utiles de webhook
Les données utiles de webhook comportent des informations sur l’événement qui s’est produit. Elles comprennent des _links à la ressource correspondante qui a déclenché l’événement. Les données utiles comportent également des attributs tels que l’horodatage, le sujet de l’événement et l’identifiant de la ressource.
Exemple de données utiles de webhook
{
"accountId": "1009688230",
"id": "a49ba790-9cc5-4502-9f4a-dccc72460cf1",
"merchantRefNum": "2e568da7c4643d567d60",
"amount": 500,
"usage": "SINGLE_USE",
"executionMode": "SYNCHRONOUS",
"currencyCode": "USD",
"type": "PAYMENT_HANDLE",
"status": "COMPLETED",
"paymentType": "CARD"
}
Voir Événements de webhooks pour la liste complète des événements dans l’API pouvant déclencher des webhooks.
Paysafe recommande fortement les webhooks pour les modes de paiement qui nécessitent un flux de « redirection », comme Skrill, Paysafecard, Paysafecash, Paypal, Interac, VIP Preferred et Play+ (Sightline).