Lire, annuler, rembourser et mettre à jour les transactions

Découvrez les actions que vous pouvez entreprendre lorsque vous utilisez l'API Transactions d'Affirm. Découvrez comment lire, annuler, rembourser et mettre à jour une transaction.

Aperçu

Après avoir créé un transaction, vous pouvez le gérer tout au long des différents états et intégrer chacune des actions dans votre système de gestion des commandes, où vous traitez les commandes et/ou traitez les paiements, les remboursements et les annulations.


Lire, annuler, rembourser et mettre à jour une transaction

Lire

With the Read Transaction API, you can use the id returned from the transaction object to retrieve all checkout data and the transaction status of a specific transaction. Reading transaction information is useful for:

  • Mettre à jour vos dossiers ou votre système de gestion des commandes en indiquant l'état actuel d'une transaction avant d'effectuer toute action sur celle-ci.
  • Maintenir votre système en synchronisation avec Affirm si votre personnel gère manuellement les prêts dans le tableau de bord du commerçant.

Vous pouvez lire une ou plusieurs transactions. Lorsque vous ne spécifiez pas id, la réponse comprend une liste de transactions. Vous pouvez définir comment les résultats sont paginés en utilisant les paramètres de requête limit, before et after.

// Read a single transaction
curl https://sandbox.affirm.com/api/v1/transactions/id
     -X GET
     -u "public_key:private_key"
 
// Read multiple transactions
curl https://sandbox.affirm.com/api/v1/transactions/?limit=5&before=1234-ABCD
     -X GET
     -u "public_key:private_key"

Annuler

When you void an authorized transaction, we:

  • Annulons définitivement le prêt.
  • Avisons l'utilisateur que la transaction a été annulée.

Pour annuler ou supprimer une transaction autorisée, utilisez id associé à la transaction pour l'annuler. Par exemple, cela peut se produire lorsqu'un utilisateur décide d'annuler sa commande avant qu'elle ne soit exécutée.

❗️

Remarque : Nous ne pouvons annuler que les prêts non capturés.

curl https://sandbox.affirm.com/api/v1/transactions/id/void
     -X POST
     -u "(public_api_key):(private_api_key)"

remboursement

You can refund a transaction based on the original purchase, similar to refunding a credit card transaction. Affirm automatically calculates all interest and fees corresponding to the refunded amount.

Vous pouvez également rembourser une partie d'une transaction en spécifiant un montant précis. Pour les remboursements partiels, vous pouvez appliquer n'importe quel montant de remboursement tant que le solde du prêt est positif.

When a loan is fully refunded, it can’t be reinstated. You can refund the customer using the Refund Transaction request or the Merchant Dashboard.

curl https://sandbox.affirm.com/api/v1/transactions/id/refund
     -X POST
     -u "(public_api_key):(private_api_key)"
     -H "Content-Type: application/json"
     -d '{"amount": 20000}'

Mettre à jour

You can use the Update Transaction request to update a transaction with new fulfillment or order information, such as shipping_confirmation, shipping_carrier, or order_id. Settlement reports associate your internal order IDs with specific Affirm transactions.

curl https://sandbox.affirm.com/api/v1/transactions/id/update
     -X POST
     -u "(public_api_key):(private_api_key)"
     -H "Content-Type: application/json"
     -d '{"order_id": "order_125", "shipping_carrier": "USPS", "shipping_confirmation": "C12345678901234", "shipping": {"name":{ "full": "John Doe"},"address": {"line1": "123 Example Street", "state": "CA", "city": "San Francisco", "zipcode": "94107", "country": "USA"}}}'