Sample - Stripe API
GET/v1/treasury/outbound_transfers/{outbound_transfer}

Get an outbound transfer

Retrieves the details of an existing OutboundTransfer by its unique identifier. Pass outbound_transfer from an OutboundTransfer creation response or list, and use expand to request additional response fields inline.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
outbound_transferstringrequired
Unique identifier of the OutboundTransfer to retrieve. Maximum 5000 characters.
expandarray<string>optional
Response fields to expand; each value can contain up to 5000 characters.

2 status codes
200Returns the requested OutboundTransfer, including its amount, currency, source FinancialAccount, destination payment method details, expected arrival date, and 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 identify the OutboundTransfer to retrieve and must not exceed 5000 characters. Each value in expand must be a string of no more than 5000 characters.