Create an OutboundTransfer

Creates an OutboundTransfer.

post/v1/treasury/outbound_transfers

Response

Successful response.

amountinteger required

Amount (in cents) transferred.

cancelableboolean required

Returns true if the object can be canceled, and false otherwise.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

descriptionstring nullable

An arbitrary string attached to the object. Often useful for displaying to users.

destination_payment_methodstring nullable

The PaymentMethod used as the payment instrument for an OutboundTransfer.

expected_arrival_dateinteger required

The date when funds are expected to arrive in the destination account.

financial_accountstring required

The FinancialAccount that funds were pulled from.

hosted_regulatory_receipt_urlstring nullable

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object'treasury.outbound_transfer' required

String representing the object's type. Objects of the same type share the same value.

statement_descriptorstring required

Information about the OutboundTransfer to be sent to the recipient account.

status'canceled' | 'failed' | 'posted' | 'processing' | 'returned' required

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.

Changes

Changed in 9 of the 51 revisions of this API.161726

Nov 5, 202562e8dc4ed8691See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Oct 22, 20251e483c60b4801See the full diff
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
Aug 19, 20257b79777e9bbd2See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Jul 22, 2025c4dc6dbe947e1See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Feb 14, 20251199cc3c557429See the full diff
- ▲
  the response property /////////////// became optional for the status
  response-property-became-optional
- ▲
  the response property //////////// became optional for the status
  response-property-became-optional
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 17, 2025b8a91ebdacb7110See the full diff
- ●
  added the new financial_account enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Dec 14, 202446de5407335916See the full diff
- ●
  added the new al_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Dec 11, 2024d8ab202758612See the full diff
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Oct 23, 202433103c93fb8c14See the full diff
- ▲
  the ///////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ///////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ///////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////// response's property type changed from no type to object for status
  response-property-type-changed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.

Full history