List Payouts
stripe.list_payouts
ActionBusiness appsconnection required
Calls the Stripe API with the connection's secret key.
List Stripe payouts to your bank account, newest first.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Stripe
- Secret shape
- the Stripe secret key (sk_...)
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
status Return only payouts in this state. Stripe's list filter accepts these four; a payout in transit is reported as in_transit on the object but cannot be filtered for. | string | No | — | one of "pending", "paid", "failed", "canceled" | — |
destination Return only payouts to this bank account or card id. | string | No | — | — | — |
limit How many objects to return, 1-100. Stripe defaults to 10. | number | No | 10 | 1–100 | — |
starting_after Cursor: return the page after this object id, for walking forward. | string | No | — | — | — |
ending_before Cursor: return the page before this object id, for walking backward. | string | No | — | — | — |
created_after Only objects created at or after this Unix timestamp, in seconds. | number | No | — | ≥ 0 | — |
created_before Only objects created at or before this Unix timestamp, in seconds. | number | No | — | ≥ 0 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"limit": 10
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
payouts[].id The payout id (po_...). | string | — |
payouts[].amount Amount paid out, in the currency's minor unit. | number | — |
payouts[].currency Three-letter lowercase ISO currency code. | string | — |
payouts[].status One of pending, in_transit, paid, failed or canceled. | string | — |
payouts[].method standard or instant. | string | — |
payouts[].type bank_account or card. | string | — |
payouts[].destination The bank account or card the money went to. | string | — |
payouts[].description The description stored on the payout. | string | — |
payouts[].statement_descriptor What appears on the bank statement. | string | — |
payouts[].failure_message Why the payout failed, when it did. | string | — |
payouts[].arrival_date When the money is expected to land, Unix seconds. | number | — |
payouts[].created Creation time, as a Unix timestamp in seconds. | number | — |
count How many objects this page returned. | number | — |
has_more True when Stripe has a further page to fetch. | boolean | — |
{
"count": 0,
"has_more": false,
"payouts": [
{
"amount": 0,
"arrival_date": 0,
"created": 0,
"currency": "",
"description": "",
"destination": "",
"failure_message": "",
"id": "",
"method": "",
"statement_descriptor": "",
"status": "",
"type": ""
}
]
}See List Payouts run in a workflow.
In a technical demo we add the Stripe connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.