Finalize a Card

Aperçu

Si un commerçant ne capture pas la totalité du montant du prêt autorisé sur une carte virtuelle ou effectue un remboursement partiel, Affirm attendra pendant une « période d'autorisation » (45 jours par défaut) pour que le commerçant résolve les autorisations en attente. Cependant, cela signifie que le client doit également attendre la période complète 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 soumission de la dernière capture prévue sur la carte. La finalisation de la carte améliore l'expérience utilisateur en garantissant que vos clients reçoivent des remboursements rapides.

📘

Finaliser la carte virtuelle

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

• If no funds have been captured, the loan will be voided/canceled.
• If any funds have been captured, the loan will be refunded down to the amount that is outstanding (including a full refund, if the card has been fully refunded).

📘

Soutien

If you are unsure if that applies to your business, please contact us via the support widget.

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 souhaitez toujours capturer sur la carte, n'utilisez pas encore l'API Finaliser. Vous pouvez appeler l'API Finalize lorsque vous avez terminé la capture.

📘

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 on order_status:

The exact definition of a “fully captured” order will depend on your business logic. The core idea is that there are no funds remaining to be captured for the order. E.g.: this would both count for “happy path” orders where 100% of the funds are captured and partial cancellations where, for instance, 60% was captured, and the remaining 40% was canceled; in this case, 100% of the funds that need to be captured are already captured, so the Finalize API can be hit.

É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

Example of a successful response:

{
  "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

👍

Successful response

Une 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 en état capturé, l'authentification de la carte doit être expirée et le montant débité doit être remboursé sur le solde actuellement capturé sur la carte.

Une fois l'événement planifié exécuté, ce prêt sera soit supprimé du portail utilisateur Affirm du client, soit son calendrier de paiement sera remboursé et mis à jour au montant approprié.

❗

Bad request

• 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.
• The current agent does not have update permission on the charge (wrong merchant).
• The charge is being disputed.
• 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).

❗

Production Environment

Disponible uniquement dans l'environnement de production en pratique. Doit accéder aux infrastructures de paiement.