POST
/v1/test_helpers/treasury/received_debitsTest mode: Create a ReceivedDebit
Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
amountintegerrequired
Amount (in cents) to be transferred.
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
descriptionstringoptional
An arbitrary string attached to the object. Often useful for displaying to users.
expandarray<string>optional
Specifies which fields in the response should be expanded.
financial_accountstringrequired
The FinancialAccount to pull funds from.
initiating_payment_method_detailsobjectoptional
Initiating payment method details for the object.
networkstringrequired
Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
200Successful response.
amountintegerrequired
Amount (in cents) transferred.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
descriptionstringrequired
An arbitrary string attached to the object. Often useful for displaying to users.
failure_codestringoptional
Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.
financial_accountstringoptional
The FinancialAccount that funds were pulled from.
hosted_regulatory_receipt_urlstringoptional
A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
idstringrequired
Unique identifier for the object.
initiating_payment_method_detailsobjectoptional
linked_flowsobjectrequired
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
networkstringrequired
The network used for the ReceivedDebit.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
reversal_detailsobjectoptional
Details describing when a ReceivedDebit might be reversed.
statusstringrequired
Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.
transactionstringoptional
The Transaction associated with this object.
defaultError response.
errorobjectrequired
Error handling
Any other status is an error: Error response.