Stripe ACTION
List Payouts
Find or list payouts. By default returns an array of payout objects (auto-paginated up to
Limit). Set Return Pagination Info to true to instead receive { data, has_more, next_starting_after } for a single Stripe page (max 100 per call) — pass next_starting_after as Starting After on the next call to iterate. See the documentation.- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Stripe account once, then configure and run List Payouts 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-list-payouts",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
stripe: { authProvisionId: "apn_xxxxxxx" },
status: "Payout Status",
limit: 10,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "stripe-list-payouts",
"configured_props": {
"stripe": { "authProvisionId": "apn_xxxxxxx" },
"status": "Payout Status",
"limit": 10
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "stripe",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "stripe-list-payouts",
arguments: {
status: "Payout Status",
limit: 10,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
status Payout Status | string | The status of the payouts to be returned. If not specified, all payouts will be returned. Optional |
limit Result Limit | integer | Maximum records to return. Auto-paginated up to 10000 by default; capped at 100 when Return Pagination Info is enabled (Stripe's per-call limit). Required |
createdGt Created (Greater Than) | string | Only return transactions that were created after this date (exclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z Optional |
createdGte Created (Greater Than Or Equal To) | string | Only return transactions that were created after this date (inclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z Optional |
createdLt Created (Less Than) | string | Only return transactions that were created before this date (exclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z Optional |
createdLte Created (Less Than Or Equal To) | string | Only return transactions that were created before this date (inclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z Optional |
arrivalDateGt Arrival Date (Greater Than) | string | Only return transactions that were created after this date (exclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z Optional |
arrivalDateGte Arrival Date (Greater Than Or Equal To) | string | Only return transactions that were created after this date (inclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z Optional |
arrivalDateLt Arrival Date (Less Than) | string | Only return transactions that were created before this date (exclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z Optional |
arrivalDateLte Arrival Date (Less Than Or Equal To) | string | Only return transactions that were created before this date (inclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z Optional |
destination Destination | string | The ID of an external account - only return payouts sent to this external account. Optional |
endingBefore Ending Before | string | A cursor for use in pagination. Ending Before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. Optional |
startingAfter Starting After | string | A cursor for use in pagination. Starting After is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. Optional |
returnPaginationInfo Return Pagination Info | boolean | If true, returns { data, has_more, next_starting_after } instead of a plain array. Use this to paginate: pass the returned next_starting_after value as Starting After on the next call to fetch the next page. Default false returns an auto-paginated array. Optional |
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-list-payouts
- Version
- 0.2.1
- App
- Stripe
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗