The Outbound Payment object

Attributes

id string Unique identifier for the object.
object string, value is "treasury.outbound_payment" 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.
customer nullable string ID of the customer to whom an OutboundPayment is sent.
description nullable string An arbitrary string attached to the object. Often useful for displaying to users.
destination _ payment _ method nullable string The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data.
destination _ payment _ method _ details nullable object Details about the PaymentMethod for an OutboundPayment.
end _ user _ details nullable object Details about the end user.
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.
purpose nullable enum Preview feature The purpose of the OutboundPayment, if applicable. Possible enum values payroll The purpose of the OutboundPayment is payroll.
returned _ details nullable object Details about a returned OutboundPayment. Only set when the status is returned.
statement _ descriptor string The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
status enum Current status of the OutboundPayment: processing, failed, posted, returned, canceled. An OutboundPayment is processing if it has been created and is pending. The status changes to posted once the OutboundPayment has been “confirmed” and funds have left the account, or to failed or canceled. If an OutboundPayment 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 OutboundPayment

POST / v1 / treasury / outbound_payments

Creates an OutboundPayment.

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.
customer string ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the destination_payment_method passed in.
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 OutboundPayment. Exclusive with destination_payment_method_data.
destination _ payment _ method _ data object Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with destination_payment_method.
destination _ payment _ method _ options object Payment method-specific configuration for this OutboundPayment.
end _ user _ details object End user 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.
purpose enum Preview feature The purpose of the OutboundPayment, if applicable. This list is not exhaustive, do not specify this parameter if your purpose does not match any that are provided. Possible enum values payroll
statement _ descriptor string The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for ach payments, 140 characters for us_domestic_wire payments, or 500 characters for stripe network transfers. Can only include -#.
amp;*, spaces, and alphanumeric characters. The default value is “payment”.

Returns

Returns an OutboundPayment object if there were no issues with OutboundPayment creation.

Response

Retrieve an OutboundPayment

GET / v1 / treasury / outbound_payments /:id

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

Parameters

No parameters.

Returns

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

Response