Transfert de fonds avec Treasury à l'aide d'objets ReceivedDebit

Comment les titulaires de comptes externes peuvent retirer des fonds d'un compte financier Treasury.

Certains processus initiés en dehors de Stripe Treasury entraînent une sortie de fonds d’un compte financier Treasury, notamment :

Dépenser de l’argent sur une carte via Stripe Issuing
Retirer de l’argent sur un compte financier et le déposer sur un compte externe via des prélèvements ACH
Retirer de l’argent d’un compte financier d’une plateforme pour le déposer sur son solde Stripe Payments sur la même plateforme à l’aide de recharges

Ces mouvements de fonds génèrent des objets ReceivedDebit. Vous ne créez pas ces objets directement, vous observez seulement leur création à l’aide de webhooks. Dans la grande majorité des cas, si les fonds du compte sont insuffisants pour effectuer l’opération, le ReceivedDebit échoue.

Récupérer un ReceivedDebit

Utilisez GET /v1/treasury/received_debits/{{RECEIVED_DEBIT_ID}} pour récupérer le ReceivedDebit avec l’ID associé.

Sauf échec de l’opération, la réponse renvoie l’objet ReceivedDebit et l’ID associé. Certains des paramètres de la réponse comportent des informations supplémentaires qui ne sont renvoyées que si vous les ajoutez comme valeurs au paramètre expand[]. Les champs que vous pouvez développer affichent le commentaire “Expandable”, comme illustré dans l’exemple de réponse suivant. Pour en savoir plus sur le développement des objets renvoyés, consultez la section consacrée à ce sujet.

JSON (commenté)
{
  "id": "{{RECEIVED_DEBIT_ID}}",
  "object": "received_debit",
  "livemode": Boolean,
  "created": Timestamp,
  // The FinancialAccount funds have been pulled from
  "financial_account": "{{FINANCIAL_ACCOUNT_ID}}", // Expandable
  "amount": 1000,
  "currency": "usd",
  "description": "Testing",

Lister des ReceivedDebits

Utilisez GET /v1/treasury/received_debits pour récupérer tous les ReceivedDebits d’un compte financier. Vous devez indiquer l’ID d’un compte financier pour le paramètre financial_account. Vous pouvez filtrer les résultats en utilisant les paramètres de liste standard ou par status.

{
  // Standard list parameters
  "limit", "starting_after", "ending_before",
  // Filter by FinancialAccount (Required)
  "financial_account": "{{FINANCIAL_ACCOUNT_ID}}",
  // Filter by status
  "status": "succeeded" | "failed"
}

La requête suivante permet de récupérer le dernier objet ReceivedDebit ayant abouti avant le ReceivedDebit fourni pour le compte financier identifié.

Tester des ReceivedDebits

Stripe Treasury fournit des endpoints de test pour les objets ReceivedDebit. Utilisez POST /v1/test_helpers/treasury/received_debits pour simuler la création d’un ReceivedDebit en mode test. Étant donné que vous ne pouvez pas créer d’objets ReceivedDebit en mode production, utilisez cet endpoint pour tester le mouvement de fonds entraîné par la création d’un ReceivedDebit par un tiers. Définissez le paramètre financial_account sur l’ID du compte financier vers lequel transférer les fonds et le paramètre network sur ach. Vous pouvez aussi indiquer l’adresse financière ABA dans le paramètre source_details.aba. Comme en mode production, les ReceivedDebits en mode test échouent si les fonds disponibles sont insuffisants.

Webhooks relatifs aux ReceivedDebits

Stripe envoie les événements ReceivedDebit suivants à votre endpoint de webhook :

treasury.received_debit.created à la création de l’événement ReceivedDebit.