Inbound Transfers

Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.

Was this section helpful? Yes No

Create an InboundTransfer

POST / v1 / treasury / inbound_transfers

Retrieve an InboundTransfer

GET / v1 / treasury / inbound_transfers /:id

List all InboundTransfers

GET / v1 / treasury / inbound_transfers

Cancel an InboundTransfer

POST / v1 / treasury / inbound_transfers /:id / cancel

Test mode: Fail an InboundTransfer

POST / v1 / test_helpers / treasury / inbound_transfers /:id / fail

Test mode: Return an InboundTransfer

POST / v1 / test_helpers / treasury / inbound_transfers /:id / return

Test mode: Succeed an InboundTransfer

POST / v1 / test_helpers / treasury / inbound_transfers /:id / succeed

The InboundTransfer object

Attributes

id string Unique identifier for the object.
object string, value is "treasury.inbound_transfer" String representing the object’s type. Objects of the same type share the same value.
amount integer Amount (in cents) transferred.
cancelable boolean Returns true if the InboundTransfer is able to be canceled.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
description nullable string An arbitrary string attached to the object. Often useful for displaying to users.
failure _ details nullable object Details about this InboundTransfer’s failure. Only set when status is failed.
financial _ account string The FinancialAccount that received the funds.
hosted _ regulatory _ receipt _ url nullable string A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
linked _ flows object Other flows linked to an InboundTransfer.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
metadata map 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.
origin _ payment _ method nullable string The origin payment method to be debited for an InboundTransfer.
origin _ payment _ method _ details nullable object Details about the PaymentMethod for an InboundTransfer.
returned nullable boolean Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.
statement _ descriptor string Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.
status enum 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.
status _ transitions object Hash containing timestamps of when the object transitioned to a particular status.
transaction nullable string Expandable The Transaction associated with this object.

Create an InboundTransfer

POST / v1 / treasury / inbound_transfers

Creates an InboundTransfer.

Parameters

amount integer Required Amount (in cents) to be transferred.
currency enum Required Three-letter ISO currency code, in lowercase. Must be a supported currency.
financial _ account string Required The FinancialAccount to send funds to.
origin _ payment _ method string Required The origin payment method to be debited for the InboundTransfer.
description string An arbitrary string attached to the object. Often useful for displaying to users.
metadata map 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
statement _ descriptor string The complete description that appears on your customers’ statements. Maximum 10 characters. Can only include -#.
amp;*, spaces, and alphanumeric characters.

Returns

Returns an InboundTransfer object if there were no issues with InboundTransfer creation. The status of the created InboundTransfer object is initially marked as processing.

Response