POST /v1/payouts

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.

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
`method`	String	No	The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts. Possible values: `"standard"` `"instant"`
`description`	String	No	An arbitrary string attached to the object. Often useful for displaying to users.
`destination`	String	No	The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.
`amount`	Integer	Yes	A positive integer in cents representing how much to payout.
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`source_type`	String	No	The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`. Possible values: `"bank_account"` `"card"` `"fpx"`
`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`.
`statement_descriptor`	String	No	A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.
`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.