Cas d'utilisation pour le développement des réponses

Utilisez le paramètre expand dans votre requête API pour récupérer des informations que l’API ne renvoie pas dans sa réponse par défaut. Les cas d’usage suivants illustrent ceci pour les informations les plus demandées.

Consulter les frais appliqués par Stripe pour un paiement donné

Vous pouvez consulter les frais de traitement d’un paiement une fois que le paiement a été traité et que Stripe a créé l’opération sur solde. L’événement charge.updated fait référence à la propriété balance_transaction (par exemple, txn_123), qui indique qu’elle est prête à l’emploi.

Plutôt que de rechercher l’opération de solde séparément, vous pouvez la récupérer en effectuant un seul appel à l’aide de l’objet expand.

curl https://api.stripe.com/v1/payment_intents/pi_1Gpl8kLHughnNhxyIb1RvRTu \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "expand[]"="latest_charge.balance_transaction" \
  -G

Utilisateurs de la version du 01/08/2022 de l’API ou une version ou antérieure :

curl https://api.stripe.com/v1/payment_intents/pi_1Gpl8kLHughnNhxyIb1RvRTu \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "expand[]"="charges.data.balance_transaction" \
  -G

Lorsque vous utilisez automatic_async (la capture_method par défaut depuis la version 2024-04-10), les opérations sur solde sont créées après la réussite du paiement, mais de manière asynchrone en arrière-plan. Cela signifie que :

• Le champ balance_transaction de l’objet Débiter peut être défini sur null immédiatement après la confirmation
• Si vous développez balance_transaction ou latest_charge.balance_transaction, il est possible qu’il ne soit pas disponible dans la réponse
• Vous pouvez écouter l’événement charge.updated pour savoir quand l’opération sur solde sera disponible

Ce comportement asynchrone améliore les performances de paiement, mais nécessite que votre intégration gère la possibilité que l’opération sur solde ne soit pas immédiatement disponible.

Consulter les frais inclus dans un virement

Chaque virement automatique est lié à des modifications historiques du solde de votre compte Stripe. L’API enregistre ces modifications sous forme d’opérations sur solde, que vous pouvez retrouver à l’aide d’une liste des opérations sur solde. Depuis cette liste d’opérations, vous pouvez développer la propriété source pour réunir des informations sur l’élément ayant abouti à l’évolution du solde du compte (paiement, remboursement, transfert, etc.). Par exemple :

curl https://api.stripe.com/v1/balance_transactions \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d payout=po_1Gl3ZLLHughnNhxyDrOia0vI \
  -d type=charge \
  -d "expand[]"="data.source" \
  -G

En savoir plus sur le rapprochement des virements.

Si vous utilisez Connect avec des paiements indirects, vous pouvez récupérer les mêmes informations au nom de vos comptes connectés. Une différence toutefois : les paiements indirects concernent à la fois un transfert et un paiement lié (sous la forme d’un objet Charge) pour déplacer les fonds vers un compte connecté. Ainsi, lorsque vous répertoriez les opérations sur solde regroupées dans les virements de votre compte connecté, la source de chaque opération sur solde est liée au paiement du transfert plutôt qu’au paiement d’origine. Pour récupérer celui-ci, vous devez développer le transfert lié d’un paiement par le biais de la propriété source_transfer, puis la propriété source_transaction du transfert :

curl https://api.stripe.com/v1/balance_transactions \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d payout=po_1G7bnaD2wdkPsFGzdVOqU44u \
  -d type=payment \
  -d "expand[]"="data.source.source_transfer.source_transaction" \
  -H "Stripe-Account: acct_1G7PaoD2wdkPsFGz" \
  -G