ExplorePricingDocsCommunityBlogCareers
  Star
Sign InSign Up Free!
← Stripe

Cancel Or Reverse a Payout with Stripe API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Cancel Or Reverse a Payout with the Stripe API
No credit card required
Into to Pipedream
▶
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

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

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers ♥ Pipedream

Getting Started

Create a workflow to Cancel Or Reverse a Payout with the Stripe API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Cancel Or Reverse a Payout action
    1. Connect your Stripe account
    2. Select a Payout ID
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Cancel Or Reverse a Payout with Stripe API on New Requests from HTTP / Webhook API
HTTP / Webhook + Stripe
 
Try it
Cancel Or Reverse a Payout with Stripe API on New Item in Feed from RSS API
RSS + Stripe
 
Try it
Cancel Or Reverse a Payout with Stripe API on New Message from Discord API
Discord + Stripe
 
Try it
Cancel Or Reverse a Payout with Stripe API on New Message In Channels from Slack API
Slack + Stripe
 
Try it
Cancel Or Reverse a Payout with Stripe API on New Message in Channel from Discord Bot API
Discord Bot + Stripe
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Cancel Or Reverse a Payout on Stripe
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
Version:0.0.2
Key:stripe-cancel-or-reverse-payout

Code

const stripe = require("../../stripe.app.js");

module.exports = {
  key: "stripe-cancel-or-reverse-payout",
  name: "Cancel Or Reverse a Payout",
  type: "action",
  version: "0.0.2",
  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: {
    stripe,
    id: {
      propDefinition: [
        stripe,
        "payout",
      ],
      optional: false,
    },
  },
  async run({ $ }) {
    const payout = await this.stripe.sdk().payouts.retrieve(this.id);
    let resp;
    switch (payout.status) {
    case "paid":
      resp = await this.stripe.sdk().payouts.reverse(this.id);
      $.export("$summary", "Successfully reversed paid payout");
      return resp;
    case "pending":
      resp = await this.stripe.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");
    }
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
StripestripeappThis component uses the Stripe app.
Payout IDidstringSelect a value from the drop down menu.

Authentication

Stripe uses API keys for authentication. When you connect your Stripe account, Pipedream securely stores the keys so you can easily authenticate to Stripe APIs in both code and no-code steps.

Stripe uses API keys to authenticate requests (more info in their docs here).

To connect Pipedream to your Stripe account,

  1. Create a Stripe API key
  2. Make sure to create either a Secret or Restricted key
  3. Enter the API key below

To help ensure proper security, we recommend you create a Restricted key, and only allow access to operations you need require in Pipedream.

About Stripe

Payment Platform

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 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
New Failed Invoice Payment from the Stripe API

Emit new event for each new failed invoice payment

 
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

Explore Other Apps

1
-
12
of
1400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Beta
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Beta
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular apps like ChatGPT and DALL·E 2.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Discord
Discord
Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
abcdefghijklmnopqrstuvwxyz#
Pipedream, Inc. — San Francisco, CA
AboutTwitterDocsCommunityTermsPrivacy