Create an InboundTransfer

Creates an InboundTransfer.

post/v1/treasury/inbound_transfers

Response

Successful response.

amountinteger required

Amount (in cents) transferred.

cancelableboolean required

Returns true if the InboundTransfer is able to be canceled.

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.

financial_accountstring required

The FinancialAccount that received the funds.

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.inbound_transfer' required

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

origin_payment_methodstring nullable

The origin payment method to be debited for an InboundTransfer.

returnedboolean nullable

Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.

statement_descriptorstring required

Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.

status'canceled' | 'failed' | 'processing' | 'succeeded' required

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.

Changes

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

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, 2025b8a91ebdacb7412See 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 financial_account enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new outbound_transfer enum value to the /////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new outbound_transfer enum value to the //////// response property for the response status
  response-property-enum-value-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
- ○
  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