Sample - Stripe API
POST/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}

Update a test-mode outbound transfer

Updates a test-mode OutboundTransfer with network-specific tracking details. Supply the outbound_transfer identifier and tracking_details for an OutboundTransfer that is not cancelable and is not canceled or failed; use expand to request expanded response fields.

  • 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
outbound_transferstringrequired
The unique identifier of the test-mode OutboundTransfer to update.

Form data containing required network tracking details and optional response expansions.

expandarray<string>optional
Specifies which fields in the response should be expanded.
tracking_detailsobjectrequired
Details about network-specific tracking information.

2 status codes
200Returns the updated OutboundTransfer with its tracking details and current transfer status.
amountintegerrequired
Amount (in cents) transferred.
cancelablebooleanrequired
Returns `true` if the object can be canceled, and `false` otherwise.
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.
destination_payment_methodstringoptional
The PaymentMethod used as the payment instrument for an OutboundTransfer.
destination_payment_method_detailsobjectrequired
expected_arrival_dateintegerrequired
The date when funds are expected to arrive in the destination account.
financial_accountstringrequired
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.
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.outbound_transfer
returned_detailsobjectoptional
Details about a returned OutboundTransfer. Only set when the status is `returned`.
statement_descriptorstringrequired
Information about the OutboundTransfer to be sent to the recipient account.
statusstringrequired
Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.
Allowed:canceledfailedpostedprocessingreturned
status_transitionsobjectrequired
tracking_detailsobjectoptional
Details about network-specific tracking information if available.
transactionstringrequired
The Transaction associated with this object.
defaultError response.
errorobjectrequired

Error handling

outbound_transfer must be a string no longer than 5000 characters and must identify a test-mode OutboundTransfer that is not cancelable and is not in the canceled or failed state. tracking_details and its type are required; type must be ach or us_domestic_wire, and an ach value must include trace_id.