Contenu
Processus d'Implémentation
Les intégrations Direct API nécessitent un peu de codage. Vous devez effectuer certaines opérations avant de pouvoir les déployer sur votre compte de production et les mettre en ligne :
- Récupérer Vos Clés API
- Développement
- Tester Votre Intégration
- Initier un paiement
- Autoriser les charges
- Réception du jeton de paiement
- Autoriser une charge
- Format de la demande d'autorisation
- Gérer les charges
- Format de la demande de capture + capture
- Format de la demande d'annulation + l'annulation
- Format de demande de remboursement + remboursement
- Déployer votre Intégration
Nous couvrirons les éléments en gras dans cet article. Nous couvrirons les autres étapes dans les autres étapes du guide.
Tester votre intégration
Vous devez suivre quelques étapes avant de passer en ligne pour terminer le processus d'intégration de direct API.
1. Initier un paiement
Les étapes ci-dessous donnent un aperçu général de la façon d'initier un paiement avec le mode de paiement Affirm.
- Une fois le code d'intégration Affirm.js ajouté, les commandes suivantes seront utilisées pour créer et envoyer l'objet de paiement à nos points de terminaison API.
- affirm.checkout({ }) crée et stocke l'objet de paiement.
- affirm.checkout.open() envoie l’objet de paiement à notre API de paiement.
- L'objet de paiement est la charge utile des données qui est POSTed à l'API Affirm pour initialiser le paiement.
- Les différents composants de l'objet de paiement sont décrits ci-dessous :
- Après avoir créé l'objet de paiement, appelez affirm.checkout.open() ; Cela fait ce qui suit:
- Envoie l'objet de paiement à notre API de paiement.
- Redirige le client vers le processus de paiement Affirm sur le domaine affirm.com ou lui montre une fenêtre modale Affirm.
- Valide les données requises dans l'objet de paiement.
Pour une documentation complète sur l'Initiation de paiement Affirm, cliquez ici.
2. Autoriser les charges
Les rubriques ci-dessous donnent un aperçu général de la façon d'autoriser les charges une fois que l'utilisateur a complété la demande de prêt et confirmé les conditions de son prêt.
Réception du jeton de paiement
Une fois qu'un paiement est initié et que le client confirme son prêt Affirm, nous envoyons une demande HTTP contenant le jeton de paiement à l'URL que vous avez définie dans l'objet de paiement (user_confirmation_url). Par défaut, Affirm envoie cette demande par POST. Cependant, vous pouvez configurer l'objet de paiement pour qu'Affirm envoie cette demande via GET.
Cliquez ici pour plus d'informations sur le choix d'une méthode. Pour recevoir le jeton de paiement, vous devez ajouter un script côté serveur qui lit la demande HTTP sur votre page.
Lors du développement et tests dans notre sandbox, passez par le processus de paiement dans votre navigateur pour déclencher la demande HTTP avec le jeton de paiement.
Remarque: Lorsque vous testez le processus de paiement, saisissez 1234 comme code de vérification, car nous n'envoyons pas de SMS depuis notre sandbox.
Suivez ces étapes pour recevoir le jeton de paiement :
- Initiez le paiement pour accéder à l'écran de création de compte Affirm.
- Si vous avez déjà un compte, cliquez sur se connecter.
- Si vous n'avez pas de compte existant, créez-en un comme suit:
- N'importe quel prénom et nom de famille.
- Une adresse courriel avec un format valide.
- Un numéro de téléphone cellulaire canadien valide (vous n'avez pas besoin d'avoir accès à ce numéro) que vous utiliserez lors de toutes les tentatives de paiement ultérieures.
- Une date de naissance antérieure à 18 ans.
- Quatre chiffres quelconques.
4. Saisissez 1234 pour le code de vérification et cliquez sur vérifier le doc.
5. Terminez le processus de paiement et cliquez sur confirmer le prêt.
Autoriser une charge
Après avoir terminé le processus de paiement et reçu le jeton de paiement, vous autoriserez la charge. L'autorisation génère un ID de charge de 8 caractères que vous utiliserez pour référencer à la charge à l'avenir. Vous devez autoriser une charge pour la créer complètement. Une charge n'est pas visible dans le tableau de bord du commerçant tant que vous ne l'autorisez pas.
Après avoir autorisé la charge et reçu une réponse de succès (200) avec le montant autorisé, votre page (à user_confirmation_url) doit :
- Validez que le montant autorisé correspond au total de la commande.
- Redirigez le client vers la page de confirmation de commande ou affichez un message de confirmation de commande.
- Enregistrez l'ID de charge.
- Marquez le paiement de la commande comme en attente.
S’il y a une réponse d’erreur (non-200) lors de l’autorisation de la charge ou si le montant autorisé n’est pas égal au total de la commande:
-
-
- Informez le client que le paiement a échoué.
- Redirigez le client vers l'écran de sélection du mode de paiement.
-
Format de la demande d'autorisation
URL
- Sandbox: https://sandbox.affirm.com/api/v2/charges
- En direct: https://api.affirm.com/api/v2/charges
Options
- Type: POST
- Autorisation: De base
- Type de contenu: application/JSON
- Données : Chaîne JSON
Données
- checkout_token chaîne requise
- Jeton unique utilisé pour autoriser une charge. Reçu à user_confirmation_url
- Chaîne facultative order_id .
- Identifie la commande dans le système de gestion des commandes du commerçant à laquelle cette charge correspond. Renvoyé uniquement dans la réponse s'il est inclus dans la demande.
Pour une documentation complète sur l'autorisation du prêt, cliquez ici.
3. Gérer les charges (Capturer, Annuler, Rembourser)
Bien qu'il soit recommandé d'intégrer ces fonctions (Capturer, Annuler, Rembourser) à votre système de gestion des commandes, il n'est pas nécessaire de procéder au lancement ; une fois le prêt autorisé, ces actions peuvent être traitées via le tableau de bord Affirm.
Capturer
Toutes les charges autorisées doivent être capturées afin de transférer des fonds au commerçant, comme pour capturer une transaction par carte de crédit.
Remarque: les charges doivent être capturées dans les 30 jours ou l'autorisation de prêt expirera. Après capturer le prêt:
- Nous informons le client que le prêt a été capturé et que son premier paiement est dû à Affirm dans 30 jours.
- Affirm paie le commerçant dans 2-3 jours ouvrables.
- Affirm peut traiter des remboursements complets ou partiels dans un délai de 120 jours.
Format de la demande de capture
URL
- Sandbox: https://sandbox.affirm.com/api/v2/charges/<charge_id>/capture
- En direct: https://api.affirm.com/api/v2/charges/<charge_id>/capture
Données
- order_id chaîne facultative
- Votre numéro de commande interne. Ceci est stocké pour votre propre référence future.
- shipping_carrier chaîne facultative
- Le transporteur utilisé pour l'expédition des articles facturés.
- shipping_confirmation chaîne facultative
https://jsfiddle.net/3hoevrjw/1/embedded/html
Annuler
Annuler une charge pour annuler une charge autorisée. Par exemple, annulez une charge lorsqu'un client décide d'annuler sa commande avant de la traiter. Après avoir annulé une charge:
-
-
- Nous annulons définitivement le prêt et personne ne peut le réautoriser.
- Nous informons le client de l'annulation.
-
Format de la demande d'annulation
- Sandbox: https://sandbox.affirm.com/api/v2/charges/<charge_id>/nulle
- En direct: https://api.affirm.com/api/v2/charges/<charge_id>/vide
https://jsfiddle.net/3hoevrjw/2/embedded/html
Rembourser
Remboursez les charge en fonction de l'achat initial, comme pour rembourser une transaction par carte de crédit. Affirm calcule automatiquement tous les intérêts et frais correspondant au montant remboursé. Pour les remboursements partiels, vous pouvez appliquer n'importe quel montant de remboursement tant qu'il y a un solde positif sur le prêt.
Une fois qu'un prêt a été entièrement remboursé, il ne peut pas être rétabli.
Format de la demande de remboursement
URL
- Sandbox: https://sandbox.affirm.com/api/v2/charges/<charge_id>/refund
- En direct: https://api.affirm.com/api/v2/charges/<charge_id>/remboursement
Données
- montant entier facultatif.
- Le montant à rembourser en cents USD ($500 = 50000). Si ce paramètre est absent ou nul, la totalité du solde restant du prêt sera remboursée par défaut (remboursement complet).
https://jsfiddle.net/3hoevrjw/4/embedded/html
Pour une documentation complète sur les fonctions de gestion des commandes d’Affirm, cliquez ici.