POST /v1/treasury/outbound_payments

Creates an OutboundPayment.

Servers

https://api.stripe.com/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name	Type	Required	Description
`customer`	String	No	ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the `destination_payment_method` passed in.
`destination_payment_method_options`	Object	No	Payment method-specific configuration for this OutboundPayment.
`destination_payment_method_options.us_bank_account`		No
`destination_payment_method_data`	Object	No	Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with `destination_payment_method`.
`destination_payment_method_data.metadata`	Object	No
`destination_payment_method_data.type`	String	Yes	Possible values: `"us_bank_account"` `"financial_account"`
`destination_payment_method_data.financial_account`	String	No
`destination_payment_method_data.us_bank_account`	Object	No
`destination_payment_method_data.us_bank_account.routing_number`	String	No
`destination_payment_method_data.us_bank_account.account_number`	String	No
`destination_payment_method_data.us_bank_account.financial_connections_account`	String	No
`destination_payment_method_data.us_bank_account.account_holder_type`	String	No	Possible values: `"company"` `"individual"`
`destination_payment_method_data.us_bank_account.account_type`	String	No	Possible values: `"checking"` `"savings"`
`destination_payment_method_data.billing_details`	Object	No
`destination_payment_method_data.billing_details.email`		No
`destination_payment_method_data.billing_details.name`		No
`destination_payment_method_data.billing_details.phone`		No
`destination_payment_method_data.billing_details.address`		No
`description`	String	No	An arbitrary string attached to the object. Often useful for displaying to users.
`destination_payment_method`	String	No	The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with `destination_payment_method_data`.
`amount`	Integer	Yes	Amount (in cents) to be transferred.
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`end_user_details`	Object	No	End user details.
`end_user_details.ip_address`	String	No
`end_user_details.present`	Boolean	Yes
`metadata`	Object	No	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`.
`financial_account`	String	Yes	The FinancialAccount to pull funds from.
`statement_descriptor`	String	No	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. The default value is "payment".
`currency`	String	Yes	Three-letter ISO currency code, in lowercase. Must be a supported currency.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.