View as Markdown
Stripe icon

Stripe ACTION

Cancel Or Reverse A Payout

Cancel a pending payout or reverse a paid payout. See the documentation here and here
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Stripe account once, then configure and run Cancel Or Reverse A Payout from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "stripe-cancel-or-reverse-payout",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stripe: { authProvisionId: "apn_xxxxxxx" },
    id: "Payout ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Cancel Or Reverse A Payout inputs
Property Type Description
id Payout ID string
Example: po_0JL8pIGHO3mdGsgAthGqEt0m
Required Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
stripe-cancel-or-reverse-payout
Version
0.1.5
App
Stripe
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes