Webhooks

Affirm utilise des webhooks pour informer votre application chaque fois que des événements se produisent.

🚧

Les points de terminaison Webhook ne sont pas en libre-service. Veuillez communiquer avec Affirm via le widget d'assistance.

Affirm crée un objet d'événement de caisse pour chaque occurrence qui mérite d'être notifiée. Certaines de ces occurrences peuvent être un nouveau paiement d’un client ou un paiement confirmé, et chaque événement aura son propre statut.

Lorsque vous créez un point de terminaison de type "webhook", il écoute normalement des événements spécifiques, puis agit dès que ces événements sont reçus. Techniquement, un point d'arrivée de webhook est hébergé dans votre code côté serveur (par ex., en python, node, etc.), qui gère toute poussée provenant de parties tierces et/ou spécifiques.

À propos des webhooks d'Affirm

Affirm enverra un HTTP POST demande à une URL que vous nous fournissez. L'URL fournie doit être une page ou un point de terminaison qui a été configuré pour recevoir des requêtes de nos serveurs.

🚧

Les commerçants ne peuvent pas ajouter de point de terminaison webhook, ni gérer eux-mêmes les événements via le tableau de bord Affirm. Veuillez communiquer avec nous via le widget d'assistance pour obtenir plus de détails.

Politiques Affirm

Les clients doivent s'inscrire pour que les décisions d'approbation soient incluses. L'événement confirmé est le seul événement webhook dont la présence est garantie pour chaque tentative de paiement Affirm réussie. Tous les autres événements (approuvés/non approuvés/etc.) ne seront présents que si le client a accepté la politique de partage des données Affirm. Les clients sont activement invités à activer le partage des données, et ils peuvent activer ce paramètre (« Services personnalisés ») dans leur profil d'utilisateur Affirm à tout moment.

Exigences relatives aux terminaux

• HTTP/HTTPS
• Reçoit la méthode POST
• Renvoie le statut 20x
• Prise en charge de TLS 1.2 (les certificats auto-signés ou expirés ne sont pas acceptés)
• Tarif dépendant du trafic de caisse du commerçant
• L'IP entrante est dynamique
• Type de contenu : application/x-www-form-urlencoded et application/json
• Accept-Encoding: gzip

Propriétés de la requête Webhook

• Méthode POST
• User-Agent: Affirm-Webhook
• L'IP d'origine est dynamique

Répondre à un événement webhook

Votre point de terminaison doit répondre à Affirm avec un code de statut 2xx pour indiquer que vous avez bien reçu la notification d'événement webhook. Affirm traitera tous les autres types de réponse comme une livraison échouée, y compris les codes de statut 3xx. Cela signifie que nous traiterons les redirections d'URL et les réponses « Non Modifiées » comme des échecs. Affirm ignorera toute autre information renvoyée dans les en-têtes ou le corps de la demande.

📘

Exigences du Webhook

Pour les événements de paiement, les requêtes envoyées par Affirm au point de terminaison de votre webhook sont accompagnées du content-type application/x-www-form-urlencoded et de la version application/x-www-form-urlencoded des données du champ du corps. Les événements de préqualification sont envoyés avec la version content-type application/json et une version JSON des données du champ du corps.

❗️

Affirm ne renvoie pas actuellement un événement webhook si votre point de terminaison ne l'a pas reçu avec succès.

Événements Webhook

Événements de paiement

Lorsque vos clients passent par le flux de paiement d'Affirm, vous pouvez recevoir différents événements d'état de paiement en temps réel via votre point de terminaison webhook.

• Entre dans le processus de paiement.
• Reçoit une décision de crédit.
• Confirme son prêt.

Événements pré-qualification

Lorsque vos clients passent par le flux de préqualification d'Affirm , vous pouvez recevoir différents événements de statut de préqualification via votre point de terminaison webhook.

• Reçoit une décision de crédit.
• La préqualification expire.

Quand utiliser les webhooks

Les webhooks sont facultatifs, mais parfois préférables pour les transactions en coulisse ou asynchrones, comme l'intégration In-Store, car nous attendons que le client effectue son paiement pour recevoir le checkout_id. Dans des API comme celles-ci, Affirm doit informer votre intégration des modifications apportées au statut de l'objet afin que vous puissiez agir dessus.

Certaines demandes Affirm (par ex., le paiement ou la préqualification) génèrent des événements qu’Affirm détecte et ces événements vous permettent également de partager des informations avec d’autres systèmes. Vous pouvez également utiliser des webhooks pour automatiser les tâches professionnelles :

• Mesures de performance (par ex., conversion en entonnoir, etc.)
• Rationaliser et automatiser les processus opérationnels

Inclure un ID de session dans la réponse du webhook

Vous pouvez inclure un ID de session dans les réponses du webhook en incluant l'ID de session dans l'objet de paiement envoyé, ou en incluant un ID de session dans Affirm.js.

Pour inclure l'ID de session dans Affirm.js, suivez le format inclus dans l'exemple ci-dessous :

_affirm_config =
{ public_api_key: "YOUR_PUBLIC_KEY", 
script: "https://cdn1-sandbox.affirm.com/js/v2/affirm.js", 
session_id: "YOUR_VISITOR_SESSION_ID" }

📘

Pratique du webhook

Pour obtenir plus de renseignements sur les webhooks, consultez notre article du Changelog, "Comment utiliser les webhooks avec Affirm ", un guide étape par étape sur la façon de créer des webhooks.