The OutboundTransfer object

Attributes

id string Unique identifier for the object.
object string, value is "treasury.outbound_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 object can be canceled, and false otherwise.
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.
destination _ payment _ method nullable string The PaymentMethod used as the payment instrument for an OutboundTransfer.
destination _ payment _ method _ details object Details about the PaymentMethod for an OutboundTransfer
expected _ arrival _ date timestamp The date when funds are expected to arrive in the destination account.
financial _ account string The FinancialAccount that funds were pulled from.
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.
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.
returned _ details nullable object Details about a returned OutboundTransfer. Only set when the status is returned.
statement _ descriptor string Information about the OutboundTransfer to be sent to the recipient account.
status enum 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.
status _ transitions object Hash containing timestamps of when the object transitioned to a particular status.
tracking _ details nullable object Details about network-specific tracking information if available.
transaction string Expandable The Transaction associated with this object.

Create an OutboundTransfer

POST / v1 / treasury / outbound_transfers

Creates an OutboundTransfer.

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 pull funds from.
description string An arbitrary string attached to the object. Often useful for displaying to users.
destination _ payment _ method string The PaymentMethod to use as the payment instrument for the OutboundTransfer.
destination _ payment _ method _ data object Preview feature Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with destination_payment_method.
destination _ payment _ method _ options object Hash describing payment method configuration details.
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 Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for ach transfers or 140 characters for us_domestic_wire transfers. The default value is “transfer”. Can only include -#.
amp;*, spaces, and alphanumeric characters.

Returns

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

Response

Retrieve an OutboundTransfer

GET / v1 / treasury / outbound_transfers /:id

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

Parameters

No parameters.

Returns

Returns an OutboundTransfer object if a valid identifier was provided. Otherwise, returns an error.

Response