API et Webhooks pour l'intégration programmatique des commerçants
Intégrez automatiquement les commerçants grâce à l'API d'Affirm et recevez des mises à jour en temps réel au moyen des webhooks pour un processus d'approbation facilité.
Aperçu
L'API d'intégration programmatique des commerçants et le système de webhook d'Affirm permettent aux partenaires de créer et de surveiller les commerçants de manière fluide grâce à des processus automatisés. Cette intégration est conçue pour rationaliser le processus d'intégration en permettant la création directe de marchands au moyen d'une API et la réception de mises à jour en temps réel au moyen des webhooks.
Création de commerçant
Pour créer un commerçant par programmation, utilisez l’API des commerçants d’Affirm.
Webhooks
Dans le cadre du processus d'intégration des commerçants, Affirm évalue les informations des commerçants lors du processus de souscription. Une fois qu'une décision de souscription est prise, Affirm envoie un webhook pour communiquer la mise à jour du statut (p. ex., approuvé ou refusé).
Webhook: merchant_update
| Champ | Description | Type | Requis/Optionnel |
|---|---|---|---|
event_type | Type d'événement Webhook. | Chaîne (enum) - merchant_update | Requis |
event_id | ID de l'événement Webhook spécifique. | String | Requis |
merchant_id | ID du commerçant Affirm. | String | Requis |
external_merchant_id | Identifiant du commerçant externe (tel que fourni par le partenaire). | String | Requis |
status | Statut du commerçant. | Chaîne (enum) | Requis |
message | Message concernant la mise à jour. | String | optionnel |
Statut initial
Lors de la création, le statut initial d’un commerçant sera généralement :
net_new: Le statut par défaut pour tous les nouveaux commerçants, sauf si le commerçant est créé avec le drapeau pre_approved. Ce statut est utilisé pendant que les vérifications OFAC (sanctions) sont en cours.- Après le filtrage des sanctions, les commerçants passent à :
prelaunch: indique que le commerçant a réussi les vérifications des sanctions et est admissible à recevoir du trafic en direct. Le commerçant conserve ce statut jusqu'à ce que l'équipe chargée des risques liés aux commerçants procède à un examen complet des risques.ofac_hit: Indique qu’une correspondance a été trouvée lors de l’examen de l’OFAC (p. ex., sur la liste des sanctions du Trésor américain).approved: La correspondance OFAC a été déterminée comme un faux positif, et le commerçant a passé tous les contrôles de risque suivants.denied_pbp: La correspondance OFAC était un faux positif, mais le commerçant n'a pas satisfait à tous les critères supplémentaires d'évaluation des risques.denied_ofac: La correspondance OFAC a été confirmée comme valide.
Possible Status Values
| Statut | Description |
|---|---|
net_new | Statut initial par défaut pour les commerçants, sauf pre_approved. Ceci est mis à jour une fois que les vérifications des sanctions (OFAC) sont terminées. |
prelaunch | Attribué après que le commerçant a passé le contrôle des sanctions. Les commerçants ayant ce statut peuvent commencer à recevoir du trafic. Ils restent ici jusqu’à ce qu’ils atteignent un seuil de GMV (généralement 150 $), ce qui déclenche alors une révision du risque commerçant. |
ofac_hit | Attribué si le commerçant figure sur la liste de surveillance de l'OFAC (Office of Foreign Assets Control) lors des vérifications des sanctions. |
approved | Défini dans deux cas : (1) immédiatement après la création si le drapeau pre_approved est utilisé, ou (2) après que l'équipe chargée des risques a examiné et approuvé manuellement le commerçant. |
denied_ofac | Une fois qu'un commerçant a reçu le statut ofac_hit, Affirm examinera la correspondance potentielle des sanctions. Si la correspondance est confirmée comme valide, le commerçant sera résilié pour cette raison de statut. |
denied_pbp | Ce statut est attribué lorsqu'un commerçant réussit le contrôle des sanctions (OFAC), mais échoue à satisfaire d'autres critères d'évaluation des risques. |
Exemples de charges utiles de statut
Commerçant approuvé
{
"event_type": "merchant_update",
"event_id": "string",
"merchant_id": "string",
"status": "approved",
"external_merchant_id": "external-partner-id",
"message": "update_success"
}
Commerçant refusé (p. ex. OFAC)
{
"event_type": "merchant_update",
"event_id": "string",
"merchant_id": "string",
"status": "denied_ofac",
"external_merchant_id": "external-partner-id",
"message": "update_success"
}
Mis à jour 6 months ago