Skip to navigation
API ReferencePayouts

List Payouts

Lists the Merchant’s Payouts in the key’s mode, oldest id first. Payouts are made on the Merchant’s Payout schedule, or when the Merchant asks from the dashboard on the manual schedule; they can’t be created through the API. To page, pass the last id you got as starting_after while hasMore is true.

Authentication

AuthorizationBearer

Your secret key: sk_test_… in Test mode, sk_live_… in Live mode.

Query parameters

starting_afterstringOptional

Cursor: return Payouts after this id.

limitstringOptional

Max rows to return (default 10, max 100).

Response

The calling Merchant’s Payouts, oldest-id first.

datalist of objects
This page of Payouts.
hasMoreboolean

True if more Payouts follow; pass the last id as starting_after to get them.

Errors

401
Unauthorized Error