Cancel Or Reverse a Payout

import app from "../../stripe.app.mjs"; export default { key: "stripe-cancel-or-reverse-payout", name: "Cancel Or Reverse a Payout", type: "action", version: "0.1.1", description: "Cancel or reverse a [payout](https://stripe.com/docs/payouts). " + "A payout can be canceled only if it has not yet been paid out. A payout can be reversed " + "only if it has already been paid out. Funds will be refunded to your available balance. [See" + " the docs](https://stripe.com/docs/api/payouts/cancel) for more information", props: { app, id: { propDefinition: [ app, "payout", ], optional: false, }, }, async run({ $ }) { const payout = await this.app.sdk().payouts.retrieve(this.id); let resp; switch (payout.status) { case "paid": resp = await this.app.sdk().payouts.reverse(this.id); $.export("$summary", "Successfully reversed paid payout"); return resp; case "pending": resp = await this.app.sdk().payouts.cancel(this.id); $.export("$summary", "Successfully cancelled pending payout"); return resp; case "in_transit": throw new Error("Payment is in transit"); case "canceled": throw new Error("Payment has already been canceled"); case "failed": throw new Error("Payment has already failed"); } }, };

Label	Prop	Type	Description
Stripe	`app`	`app`	This component uses the Stripe app.
Payout ID	`id`	`string`	Select a value from the drop down menu.

Label

Prop

Type

Description

Stripe

app

This component uses the Stripe app.

Payout ID

id

string

Select a value from the drop down menu.

More Ways to Use Stripe#

Triggers#

New Custom Webhook Events from the Stripe API

Emit new event on each webhook event

Try it

Canceled Subscription from the Stripe API

Emit new event for each new canceled subscription

Try it

New Abandoned Cart from the Stripe API

Emit new event when a customer abandons their cart.

Try it

New Customer from the Stripe API

Emit new event for each new customer

Try it

New Dispute from the Stripe API

Emit new event for each new dispute

Try it

Actions#

Cancel a Payment Intent with the Stripe API

Cancel a payment intent. Once canceled, no additional charges will be made by the payment intent and any operations on the payment intent will fail with an error. For payment intents with status=requires_capture, the remaining amount_capturable will automatically be refunded. See the docs for more information

Try it

Capture a Payment Intent with the Stripe API

Capture the funds of an existing uncaptured payment intent. See the docs for more information

Try it

Confirm a Payment Intent with the Stripe API

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, Stripe will attempt to initiate a payment. See the docs for more information

Try it

Create a Customer with the Stripe API

Create a customer. See the docs for more information

Try it

Create a Payment Intent with the Stripe API

Create a payment intent. Seethe docs for more information

Try it

Cancel Or Reverse a Payout with Stripe API

Pipedream makes it easy to connect APIs for Stripe and 2,500+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Integrations#

Details#

Code#

Configuration#

Authentication#

About Stripe#

More Ways to Use Stripe#

Triggers#

Actions#

Explore Other Apps#

1
-
24
of
2,500+
apps by most popular

Cancel Or Reverse a Payout with Stripe API

Pipedream makes it easy to connect APIs for Stripe and 2,500+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,500+apps by most popular

1
-
24
of
2,500+
apps by most popular