POST /v1/treasury/outbound_transfers
Creates an OutboundTransfer.
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 |
|---|---|---|---|
destination_payment_method_options |
Object | No |
Hash describing payment method configuration details. |
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 OutboundTransfer. Exclusive with |
destination_payment_method_data.type |
String | Yes |
Possible values:
|
destination_payment_method_data.financial_account |
String | 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 OutboundTransfer. |
amount |
Integer | Yes |
Amount (in cents) to be transferred. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
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 |
financial_account |
String | Yes |
The FinancialAccount to pull funds from. |
statement_descriptor |
String | No |
Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for |
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.