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

Lorsque des fonds sont transférés vers un compte financier, Stripe crée un objet ReceivedCredit correspondant sur le compte. Un ReceivedCredit contient des informations sur la façon dont les fonds ont été envoyés et, dans la mesure du possible, sur l’expéditeur. Vous pouvez envoyer des fonds vers un compte financier à l’aide des numéros de routage et de compte pour les transferts ach et us_domestic_wire, ou de l’ID du compte financier pour les transferts entre deux comptes financiers.

Lorsque les fonds proviennent d’un autre compte financier Treasury, le ReceivedCredit contient une référence linked_flows.source_flow à l’origine du mouvement de fonds. Dans ce cas, le paramètre network de l’OutboundPayment source prend la valeur stripe.

Récupérer un ReceivedCredit

Utilisez GET /v1/treasury/received_credits/{{RECEIVED_CREDIT_ID}} pour récupérer l’objet ReceivedCredit avec l’ID indiqué.

La requête suivante permet de récupérer le ReceivedCredit avec l’ID spécifié. La réponse à cette requête inclut les informations développées relatives à l’objet Transaction.

curl -G https://api.stripe.com/v1/treasury/received_credits/{{RECEIVED_CREDIT_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d "expand[]"=transaction

Sauf échec de l’opération, la réponse renvoie l’objet ReceivedCredit demandé. 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[] de votre demande. 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 sur le développement des réponses.

{
  "id": "{{RECEIVED_CREDIT_ID}}",
  "object": "received_credit",
  "livemode": true | false,
  "created": "{{Timestamp}}",
  // The FinancialAccount that received the funds
  "financial_account": "{{FINANCIAL_ACCOUNT_ID}}", // Expandable
  "amount": 1000,
  "currency": "usd",
  // The description of this movement sent by the originator

Répertorier les ReceivedCredits

Utilisez GET /v1/treasury/received_credits pour récupérer tous les ReceivedCredits du compte financier avec l’ID du paramètre obligatoire financial_account. Vous pouvez filtrer la liste en utilisant les paramètres de liste standard, par status ou linked_flows.source_flow_type.

{
  // Standard list parameters
  "limit", "starting_after", "ending_before",
  // Filter by FinancialAccount (required)
  "financial_account": "{{FINANCIAL_ACCOUNT_ID}}",
  // Filter by status
  "status": "succeeded" | "failed",
  // Filter by `source_flow_type`
  "linked_flows.source_flow_type": nil | "payout" | "outbound_payment"
}

Dans la requête suivante, les ReceivedCredits qui présentent un état failed sont récupérés sur le compte financier spécifié.

curl -G https://api.stripe.com/v1/treasury/received_credits \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d financial_account=
{{FINANCIAL_ACCOUNT_ID}} \
  -d status=failed

Sauf échec de l’opération, la réponse inclut les objets ReceivedCredit qui correspondent aux critères indiqués dans la requête.

Tester les ReceivedCredits

Utilisez POST /v1/test_helpers/treasury/received_credits pour simuler la réception de fonds sur un compte financier. Pour simuler un virement bancaire depuis un compte externe vers votre compte financier, définissez initiating_payment_method_details sur les valeurs du compte bancaire externe, et définissez network sur ach ou sur us_domestic_wire.

La requête suivante entraîne la création d’un ReceivedCredit de test à partir d’un compte bancaire externe en utilisant un OutboundPayment entre deux comptes financiers de la même plateforme.

curl https://api.stripe.com/v1/test_helpers/treasury/received_credits \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d financial_account={{DESTINATION_FINANCIAL_ACCOUNT_ID}} \
  -d network=ach \
  -d amount=1234 \
  -d currency=usd

Sauf échec de l’opération, la réponse renvoie un objet ReceivedCredit. Voici un exemple de réponse pour un virement bancaire.

{
  "financial_account": "{{FINANCIAL_ACCOUNT_ID}}",
  "network": "ach",
  "amount": "1234",
  "currency": "usd",
  "description": "Test",
  "source_details": {
    "type": "aba",
    "aba": {
      "country": "US",
      "routing_number": "12341234",
      "account_number": "0123456789",
      "account_holder_name": "Jenny Rosen",
    }
  }
}

Webhooks ReceivedCredit

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

• treasury.received_credit.created lors de la création de l’événement ReceivedCredit.
• treasury.received_credit.{{new_status}} lorsque l’état de l’événementReceivedCredit change. Il peut prendre les états suivants :
  • treasury.received_credit.succeeded
  • treasury.received_credit.failed