Skip to main content
GET
List batches

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>

Worked out from the batch's payouts, so it can move more than once.

Available options:
pending,
processing,
completed,
partially_completed,
failed,
awaiting_payees,
awaiting_funds,
canceled
Example:

"processing"

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

Batches, newest first.

data
object[]
required
has_more
boolean
required
Example:

false