Finaliser une carte

Aperçu

L’ API de finalisation est un signal affirmatif envoyé à Affirm indiquant que vous avez terminé d’effectuer des actions sur la carte virtuelle. Le point de terminaison Finaliser une carte 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 les fonds :

• N'ayant pas été capturé, le prêt est annulé.
• Si des fonds ont été capturés, le prêt est remboursé jusqu’au montant impayé, y compris un remboursement complet si la carte a été entièrement remboursée.

Si vous ne savez pas si cela s'applique à votre entreprise, communiquez avec nous via le widget d'assistance.

❗️

Remboursements à temps

Lorsqu'un commerçant ne prélève pas la totalité du montant autorisé sur une carte virtuelle ou lorsqu'il effectue un remboursement partiel, Affirm attend pendant la période d'autorisation (45 jours par défaut) que le commerçant règle les autorisations en cours. Par conséquent, le client doit également attendre la fin de la période d'autorisation avant de recevoir son remboursement.

Pour garantir que vos clients reçoivent leurs remboursements en temps opportun, nous vous recommandons d'exécuter une requête API Finalize sur une carte virtuelle au moins une semaine après la soumission de la dernière capture prévue à la carte.

Implémentation

1. Vérifiez que tout a été capturé sur la carte.

Si vous n'avez pas l'intention d'effectuer d'autres autorisations ou captures sur une carte, envoyez une requête à l'API Finalize au moins une semaine après avoir capturé toutes les autorisations existantes.

En cas d'annulation d'une commande, vérifiez que tout a bien été capturé sur la carte, même si le montant est inférieur au montant total de la commande. Si vous souhaitez toujours capturer sur la carte, n'appuyez pas encore sur l'API Finalize. Appelez l'API Finalize uniquement après avoir terminé la capture.

📘

Note

Une fois la carte virtuelle finalisée, elle ne peut plus accepter d'autorisations ni de captures supplémentaires. Le seul événement qu'Affirm prévoit après la finalisation de la carte est un remboursement.

2. [Exemple] Lancez une requête pour retourner les commandes qui doivent être finalisées.

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

La définition exacte d'une commande « entièrement capturée » dépend de votre logique commerciale. L'idée principale est qu'il ne reste aucun fonds à capturer pour la commande.

Exemple : cela concernerait à la fois les commandes « parcours nominal » où 100 % des fonds sont capturés et les annulations partielles où 60 % ont été capturés et les 40 % restants ont été annulés. Dans ce cas, 100 % des fonds qui doivent être capturés le sont déjà, de sorte que l'API de finalisation peut être utilisée.

3. Appelez l'API de finalisation.

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

Order flow diagrams

Remboursement complet pour plusieurs articles

Multi-item partial refund

Chronologie

👍

Réponse positive

Lorsqu'une réponse de confirmation est reçue, le prêt du client est partiellement ou entièrement remboursé.

• 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 production

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

Sujets recommandés

• Gestion des cartes
• Annuler une carte
• Lire les détails de la carte
• À propos de la carte virtuelle Affirm (VCN)