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.

Lire, annuler, rembourser et mettre à jour une transaction


Aperçu

Après avoir créé une 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

Avec la Read Transaction API, vous pouvez utiliser le id retourné de l'objet transaction pour récupérer toutes les données de paiement et l'état de la transaction d'une transaction spécifique. La lecture des informations sur les transactions est utile pour :

  • 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 la pagination des résultats à l'aide des 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

Lorsque vous annulez une transaction autorisée, nous :

  • 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. Notez que 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

Vous pouvez rembourser une transaction en fonction de l'achat d'origine, comme pour rembourser une transaction par carte de crédit. Affirm calcule automatiquement tous les intérêts et frais correspondant au montant remboursé.

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.

Lorsqu'un prêt est entièrement remboursé, il ne peut plus être rétabli. Vous pouvez rembourser le client en utilisant la requête Refund Transaction ou le tableau de bord du commerçant.

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

Vous pouvez utiliser la demande Update Transaction pour mettre à jour une transaction avec de nouvelles informations d'exécution ou de commande, comme shipping_confirmation, shipping_carrier, ou order_id. Les rapports de règlement associent vos ID de commandes internes à des transactions Affirm spécifiques.

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