Webhooks

Aperçu

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 creates a checkout event object for each occurrence that is worth notifying you about. Some of these occurrences could be a new checkout from a customer or a confirmed checkout, and each event will have its own status.

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 will send an HTTP POST request to a URL that you provide us with. The provided URL should be a page or endpoint that has been set up to receive requests from our servers.

🚧
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

Champs de données

🚧
Configurations des champs de données
Les champs de données ne sont pas configurables en libre-service. Pour activer ou modifier les données incluses dans les charges utiles de votre webhook, veuillez communiquer avec votre gestionnaire de compte technique ou contacter l'équipe des partenariats Affirm pour obtenir de l'aide.

Les champs de données de webhook vous permettent de personnaliser les informations incluses dans les charges utiles de webhook envoyées par Affirm à votre système. Ces champs représentent des points de données clés concernant l'identité du client, les conditions du prêt et les détails de la transaction. En sélectionnant des champs spécifiques, vous vous assurez que seules les informations pertinentes sont transmises à vos systèmes principaux, ce qui permet un suivi précis des commandes et la génération de rapports.

Renseignements sur le client

Champ	Description
Prénom	Le prénom du client.
Nom de famille	Le nom de famille du client.
Adresse courriel	L’adresse courriel du client.

Modalités de prêt/paiement

Champ	Description
Montant de l'acompte	Le paiement initial versé par le client avant de financer le solde.
A un acompte	Indique si le client avait un acompte.
Montant financé	Le montant total du coût qui est financé (après tout acompte).
Montant approuvé	Le montant total du prêt approuvé pour le client.
Frais de crédit	Le coût du financement, y compris les intérêts et les frais.
TAEG	Le taux d'intérêt appliqué au montant financé.
Nombre de paiements	Le nombre total de versements que le client doit effectuer.
Date du premier paiement	La date prévue pour le premier paiement du client.
date d'expiration	La date après laquelle l'offre de prêt ou les conditions ne sont plus valides.
Conditions de préqualification	Conditions affichées durant le processus de préadmissibilité.
Montant de crédit restant	La portion inutilisée ou restante du crédit Affirm du client.

Détails de la commande et de la transaction

Champ	Description
Numéro de commande	Identifiant unique pour la transaction/commande.
Total	Le montant total de la transaction du client.
Charge ARI	Identifiant interne lié à la facturation.

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
For checkout events, the requests sent from Affirm to your webhook endpoint come with the content-type application/x-www-form-urlencoded and a application/x-www-form-urlencoded version of the data in the body field. Prequal events are sent with the content-type application/json and a JSON version of the data in the body field.

❗️
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.

Expérience utilisateur	Événement Affirm	Événement Webhook
Le flux de paiement Affirm est ouvert et le client est invité à se connecter.	Paiement créé	`opened`
Crée ou se connecte à un compte Affirm	None	`None`
Écran de traitement	Décision d'approbation	`approved` `not_approved`
Le flux de paiement Affirm ouvert par l'utilisateur.	None	`None`
Cliquent sur confirmer et sont renvoyés au site du commerçant	Confirmation de paiement	`confirmed`

É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.

Expérience utilisateur	Événement Affirm	Événement Webhook
Le client clique sur le bouton « Voir si vous êtes admissible » dans la fenêtre modale « En savoir plus »	None	`None`
Crée ou se connecte à un compte Affirm	None	`None`
Écran de traitement	Décision d'approbation	`prequal_decision`
La préqualification expire, peut avoir lieu dans les 7 jours suivant	Expiration de préqualification	`prequal_expiry`

Quand utiliser les webhooks

Webhooks are optional but sometimes preferred for behind-the-scenes or asynchronous transactions, such as In-store integration since we are waiting on the customer to complete their checkout to receive the checkout_id. In APIs like these, Affirm needs to notify your integration about changes to the status of the object so that you can act on them.

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

You can include a session ID in the webhook responses by including the session ID in the checkout object that is sent, or by including a session ID in Affirm.js.

To include the session ID in Affirm.js, follow the format included in the example below:

_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.