Sample - Stripe API
POST/v1/test_helpers/treasury/inbound_transfers/{id}/fail

Fail a test-mode inbound transfer

Triggers a failed state for a test-mode InboundTransfer. The InboundTransfer must already be in the processing state, and you can provide failure details to describe the simulated failure.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
idstringrequired
The identifier of the test-mode InboundTransfer to fail. Maximum 5,000 characters.

Optional form data describing the simulated InboundTransfer failure.

expandarray<string>optional
Specifies which fields in the response should be expanded.
failure_detailsobjectoptional
Details about a failed InboundTransfer.

2 status codes
200Returns the updated InboundTransfer with `failed` status and its failure details, transfer amount, currency, financial account, and linked flows.
amountintegerrequired
Amount (in cents) transferred.
cancelablebooleanrequired
Returns `true` if the InboundTransfer is able to be canceled.
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).
descriptionstringoptional
An arbitrary string attached to the object. Often useful for displaying to users.
failure_detailsobjectoptional
Details about this InboundTransfer's failure. Only set when status is `failed`.
financial_accountstringrequired
The FinancialAccount that received the funds.
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.
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`.
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:treasury.inbound_transfer
origin_payment_methodstringoptional
The origin payment method to be debited for an InboundTransfer.
origin_payment_method_detailsobjectoptional
Details about the PaymentMethod for an InboundTransfer.
returnedbooleanoptional
Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.
statement_descriptorstringrequired
Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.
statusstringrequired
Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.
Allowed:canceledfailedprocessingsucceeded
status_transitionsobjectrequired
transactionstringoptional
The Transaction associated with this object.
defaultError response.
errorobjectrequired

Error handling

id must identify a test-mode InboundTransfer that is currently in the processing state. If supplied, failure_details.code must use one of the supported failure codes, such as account_closed, insufficient_funds, or invalid_account_number.