Charge Actions

Aperçu

Après avoir créé une charge, 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 où vous traitez les commandes et/ou traitez les paiements, les remboursements et les annulations.

📘
En savoir plus sur les actions de charge via notre Référence API

Inclut des exemples de demande/réponse

Définitions d'objet-JSON

Attributs requis

Lire les frais

Avec l'API Read charge , vous pouvez utiliser le charge_id pour récupérer toutes les données de paiement et le statut de la charge associés à une charge spécifique. La lecture des renseignements relatifs aux charges est utile pour mettre à jour vos dossiers ou votre système de gestion des commandes en indiquant l'état actuel d'une charge 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 les frais uniques ou multiples. Notez que si vous ne spécifiez pas charge_id, la réponse comprend une liste des charges. Vous pouvez définir la pagination des résultats à l'aide des paramètres de requête limit, before, et after .

// Read a single charge
curl https://sandbox.affirm.com/api/v2/charges/CHARGE_ID
     -X GET
     -u "public_key:private_key"
 
// Read multiple charges
curl https://sandbox.affirm.com/api/v2/charges/?limit=5&before=1234-ABCD
     -X GET
     -u "public_key:private_key"

Annuler

Pour annuler ou supprimer des frais autorisés, vous pouvez utiliser le charge_id pour l'annuler. Par exemple, lorsqu'un utilisateur décide d'annuler sa commande avant qu'elle ne soit traitée. L'annulation d'une charge 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://sandbox.affirm.com/api/v2/charges/CHARGE_ID/void
     -X POST
     -u "(public_api_key):(private_api_key)"

remboursement

Remboursez une charge en fonction 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 l'API de remboursement ou du Portail commerçant.

curl https://sandbox.affirm.com/api/v2/charges/CHARGE_ID/refund \
     -X POST
     -u "(public_api_key):(private_api_key)"
     -H "Content-Type: application/json"
     -d '{"amount": 50000}'

Mettre à jour

Utilisez l'API Update pour mettre à jour les frais avec de nouveaux renseignements de traitement ou de commande, comme shipping_confirmation, shipping_carrier, ou order_id. Les rapports de règlement associent vos ID de commandes internes à des frais Affirm spécifiques.

curl https://sandbox.affirm.com/api/v2/charges/CHARGE_ID/update
     -X POST
     -u "(public_api_key):(private_api_key)"
     -H "Content-Type: application/json"
     -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"}}}'