Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Test mode: Return an InboundTransfer

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

post/v1/test_helpers/treasury/inbound_transfers/{id}/return

Path parameters

idstring required

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.