StripeAPI.Operations.PostPayouts

POST /v1/payouts

<p>To send funds to your own bank account, you create a new payout object. Your <a href="#balance">Stripe balance</a> must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.</p>

<p>If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.</p>

<p>If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The <a href="#balance_object">balance object</a> details available and pending amounts by source type.</p>

Defines the object schema located at paths./v1/payouts.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Create a new PostPayoutsRequestBody with all required fields.

Defines the enum schema located at paths./v1/payouts.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.method in the specification.

The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)

Defines the enum schema located at paths./v1/payouts.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_type in the specification.

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`.

Represents a response of the operation postPayouts.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostPayoutsResponseError is used.