Finaliser une carte
Utilisez la requête de finalisation de l'API de carte d'Affirm pour rembourser le solde inutilisé restant sur la carte virtuelle.
Aperçu
Si un commerçant ne prélève pas le montant total du prêt autorisé sur une carte virtuelle ou n'effectue qu'un remboursement partiel, Affirm attendra un délai d'autorisation (45 jours par défaut) pour que le commerçant résolve les autorisations ouvertes.Cependant, le client devra également attendre la totalité du délai d'autorisation avant de recevoir son remboursement.
L'API Finalize est un signal affirmatif du commerçant indiquant qu'il a terminé d'effectuer des actions sur la carte virtuelle.
Affirm recommande d'exécuter la requête API de finalisation sur une carte virtuelle au moins une semaine après la dernière capture anticipée.Finaliser la carte améliore l'expérience utilisateur en garantissant des remboursements rapides à vos clients.
Finaliser la carte virtuelleUne fois que vous aurez finalisé la carte virtuelle, elle ne pourra plus accepter d'autres autorisations ni captures.
How It Works
Le point de terminaison Finalize résout un prêt autorisé ou capturé jusqu'au montant qui a été capturé sur la carte virtuelle Affirm au moment de l'exécution de la requête API.
- Si aucun fonds n’a été capturé, le prêt sera annulé.
- Si des fonds ont été capturés, le prêt sera remboursé jusqu’au montant impayé (y compris un remboursement complet si la carte a été entièrement remboursée).
SoutienSi vous n'êtes pas certain que cela s'applique à votre entreprise, veuillez nous contacter via le widget d'assistance.
Implémentation
Assurez-vous de n'appeler l'API Finaliser qu'une semaine après avoir capturé toutes les autorisations existantes et que vous n'avez pas l'intention d'effectuer d'autres autorisations ou captures sur la carte.
- En cas d'annulation de commande, assurez-vous que tout a été capturé sur la carte, même si cela est inférieur au total de la commande.
- Si vous voulez faire la capture sur la carte, n'activez pas encore l'API Finalize.Vous pourrez appeler l'API Finalize une fois la capture terminée.
Note:Veuillez noter que l'unique événement qu'Affirm attend après la finalisation de la carte est un remboursement.
Étape 1
[Example]Run a query to return orders that need to be finalized
Commandes de rétrospection pour lesquelles la dernière capture a eu lieu il y a 7 jours :
SELECT order_id, transaction_id FROM customer_orders
WHERE payment_type = 'Affirm'
AND order_status = 'fully captured' -- check notes below on order status
AND finalized_status = 0
AND last_capture_date <= DATEADD(day, -7, current_date)
Note sur leorder_status:La définition exacte d'une commande « entièrement capturée » dépendra de votre logique commerciale. L'idée principale est qu'il ne reste aucun fonds à capturer pour la commande. Par exemple : cela s’applique aussi bien aux commandes « dans le bon sens » où 100 % des fonds sont capturés qu’aux annulations partielles où, par exemple, 60 % ont été capturés et les 40 % restants ont été annulés; dans ce cas, 100 % des fonds à capturer l’ont déjà été, donc l’API Finalize peut être utilisée.
Étape 2
Appelez l'API Finalize sur ces commandes
Avec les identifiants de paiement Affirm associés aux commandes, effectuez un appel POST vers notre point de terminaison Finalize :
https://api.affirm.com/api/v2/cards/{checkout_id}/finalize
Exemple de réponse réussie :
{
"message": "The card was successfully scheduled to finalize. You should see changes reflected in 24 hours.",
"code": "success",
"checkout_token": "FA0UUFRGOND84S7C"
}
Diagrammes de flux de commandes
Remboursement complet pour plusieurs articles
Remboursement partiel de plusieurs articles
Chronologie
Réponse positiveUne fois la réponse de confirmation reçue, le prêt du client sera remboursé partiellement ou totalement.
- Si la carte est dans les états expiré, annulé ou auth_expired, ne rien faire.
- Si la carte est dans un état confirmé, expirez la carte et annulez la transaction.
- Si la carte est dans un état autorisé, l’autorisation expire la carte et annule la transaction.
- Si la carte est dans un état capturé, autorisez l'expiration de la carte et remboursez les frais sur le solde actuellement saisi sur la carte.
Une fois l'événement programmé exécuté, cela supprimera le prêt du portail utilisateur Affirm du client ou remboursera et mettra à jour le calendrier de paiement du prêt au montant approprié.
Mauvaise requête
- Le commerçant n’est pas un commerçant Platforms.vcn.
- Il n’y a pas de jeton de caisse avec ce
checkout_token.- Il n’y a pas de carte associée au
checkout_token.- L'agent actuel n'a pas l'autorisation de mettre à jour la charge (commerçant incorrect).
- La contestation de la charge est en cours.
- L'état de la carte n'est pas géré (cela ne devrait jamais se produire, sauf si nous ajoutons un nouvel élément
CardState).
Environnement de productionDisponible uniquement dans l'environnement de production en pratique. Doit accéder aux infrastructures de paiement.
Mis à jour 3 months ago