Skip to main content
GET
List payouts

Authorizations

Authorization
string
header
required

Your secret key: sk_test_… on the sandbox host, sk_live_… on live. A key on the wrong host gets a 401 wrong_environment. Keys are secret. Keep them on your server, never in a browser or app.

Query Parameters

limit
integer
default:20

How many to return.

Required range: 1 <= x <= 100
starting_after
string

The last id of the previous page. Returns the items after it.

status
enum<string>
  • awaiting_payee: money reserved, waiting for the payee to finish onboarding.
  • awaiting_funds: the payee is ready, but the balance was too low at release.
  • pending: created and handed to the payout network.
  • processing: accepted and on its way.
  • paid: delivered.
  • failed: not delivered; failure_code says why.
  • returned: delivered, then sent back by the payee's bank.
  • canceled: canceled by you while held.
  • expired: the hold ran out before the payee was ready.
Available options:
awaiting_payee,
awaiting_funds,
pending,
processing,
paid,
failed,
returned,
canceled,
expired
Example:

"pending"

payee_id
string
Example:

"payee_c8pnahcrxqzd3z8d"

batch_id
string

Every payout of one batch.

Example:

"batch_fcb4cuwtd6fcbmwr"

created[gte]
string<date-time>

Created at or after this time.

Example:

"2026-10-01T00:00:00Z"

created[lte]
string<date-time>

Created at or before this time.

Example:

"2026-10-31T23:59:59Z"

Response

Payouts, newest first.

data
object[]
required
has_more
boolean
required
Example:

false