Charge Actions

Aperçu

Après avoir créé un charge, vous pouvez le gérer grâce à plusieurs actions clés pour maintenir votre système de gestion des commandes à jour. Ces actions prennent en charge divers flux de travail tels que le traitement des paiements, des remboursements et des 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

Read Charge

Avec l'API Read Charge, vous pouvez utiliser le charge_id pour récupérer les données de caisse et l'état d'une charge spécifique. La lecture de l'information relative aux frais est utile pour synchroniser votre système de gestion des commandes avec Affirm et pour s'assurer que les enregistrements sont à jour avant de prendre d'autres mesures.

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

L'API Void Charge utilisée avec charge_id permet d'annuler ou de supprimer un prélèvement autorisé. Il est souvent utilisé lorsqu'un client annule une commande avant qu'elle ne soit exécutée. L'annulation d'une charge autorisée:

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

L'API Refund Charge vous permet d'émettre un remboursement pour le montant initial de l'achat ou un montant partiel, semblable au remboursement d'une transaction par carte de crédit. Affirm calcule automatiquement tous les intérêts et frais correspondant au montant remboursé. Pour les remboursements partiels, vous pouvez rembourser n'importe quel montant tant qu'il reste un solde positif sur le prêt. Les remboursements peuvent également être traités directement au moyen du Portail Commerçant.

Note : Une fois qu'un prêt a été entièrement remboursé, il ne peut plus être rétabli.

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 Charge pour mettre à jour les frais avec de nouveaux renseignements de traitement ou de commande, comme shipping_confirmation, shipping_carrier, ou order_id. Les détails mis à jour sont reflétés dans les rapports de règlement, reliant les frais Affirm à vos identifiants de commande internes.

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