POST /v1/transfers
To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.
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 |
|---|---|---|---|
description |
String | No |
An arbitrary string attached to the object. Often useful for displaying to users. |
destination |
String | Yes |
The ID of a connected Stripe account. See the Connect documentation for details. |
amount |
Integer | No |
A positive integer in cents (or local equivalent) representing how much to transfer. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
source_type |
String | No |
The source balance to use for this transfer. One of Possible values:
|
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 |
transfer_group |
String | No |
A string that identifies this transaction as part of a group. See the Connect documentation for details. |
source_transaction |
String | No |
You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. See the Connect documentation for details. |
currency |
String | Yes |
Three-letter ISO code for currency 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.