Actions
Comprendre les actions de l'API Transactions d'Affirm.
Aperçu
Après avoir créé une transaction
, vous pouvez la gérer tout au long des différents états et intégrer chacune de ces actions dans votre système de gestion des commandes dans lequel vous remplissez les commandes et/ou traitez les paiements, les remboursements et les annulations.
Lire
Avec l'API Lire la transaction, vous pouvez utiliser l'ID
renvoyé par l'objet transaction
pour récupérer toutes les données de caisse et l'état de la transaction associés à une transaction spécifique. La lecture des informations relatives aux 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. Il peut également 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. Notez que si vous ne spécifiez pas d'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 limite
, avant
, et après
.
// Lire une transaction unique https://api.global.sandbox.affirm.com/api/v1/transactions/id
-X GET
-u "public_key:private_key"
// Read multiple transactions
curl https://api.global.sandbox.affirm.com/api/v1/transactions/?limit=5&before=1234-ABCD
-X GET
-u "public_key:private_key"
Annuler
Pour annuler ou supprimer une transaction autorisée, utilisez l'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.
L'annulation d'une transaction autorisée effectue les opérations suivantes :
- Annule définitivement un prêt
- Avise l'utilisateur que la transaction a été annulée
curl https://api.global.sandbox.affirm.com/api/v1/transactions/id/void
-X POST
-u "(public_api_key):(private_api_key)"
remboursement
Remboursez une transaction sur la base de l'achat initial, comme pour le remboursement d'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. Pour les remboursements partiels, vous pouvez appliquer n'importe quel montant de remboursement tant que le solde du prêt est positif.
Une fois qu'un prêt a été entièrement remboursé, il ne peut plus être rétabli. Vous pouvez rembourser le client à l'aide de la demande de remboursement ou du portail des commerçants.
curl https://api.global.sandbox.affirm.com/api/v1/transactions/id/refund
-X POST
-u "(public_api_key):(private_api_key)"
-H "Content-Type: application/json"
-d '{"amount": 50000}'
Mettre à jour
Utilisez la demande Mettre à jour la transaction pour mettre à jour une transaction avec de nouvelles informations de traitement ou de commande, telles que shipping_confirmation
, shipping_carrier
ou order_id
. Les rapports d'imputation associent vos ID de commandes internes à des transactions Affirm spécifiques.
curl https://api.global.sandbox.affirm.com/api/v1/transactions/id/update
-X POST
-u "(public_api_key):(private_api_key)"
-H "Content-Type: application/json"
-H "country-code: CAN"
-d '{"order_id": "JLKM4321", "shipping_carrier": "USPS", "shipping_confirmation": "1Z23223", "shipping": {"name":{ "full": "John Doe"},"address": {"line1": "325 Pacific Ave", "state": "CA", "city": "San Francisco", "zipcode": "94111", "country": "USA"}}}'
Updated 9 months ago