provider POST /v1/payouts/{payout}/cancel
@utdk/stripe /v1/payouts/{payout}/cancel
Cancel a payout
<p>You can cancel a previously created payout if its status is <code>pending</code>. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.</p>
payout path required
string

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

postpayoutspayoutcancel
POST/v1/payouts/{payout}/cancel
<p>You can cancel a previously created payout if its status is <code>pending</code>. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.</p>

Parameters

required

Input

Specifies which fields in the response should be expanded.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.postpayoutspayoutcancel()