Skip to main content
GET
Per-vendor pending payout summary over a date window

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Query Parameters

startDate
string

Window start, YYYY-MM-DD (shop timezone) or full ISO. Defaults to the first day of the current month in the shop timezone.

endDate
string

Window end, YYYY-MM-DD (shop timezone) or full ISO. Defaults to now; a future date is clamped to now.

vendorId
string

Narrows the summary to a single vendor

first
integer

Number of vendors to return (sorted amount desc)

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

Cursor for forward pagination (from a previous page endCursor)

last
integer

Number of vendors to return (backward pagination)

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

Cursor for backward pagination (from a previous page startCursor)

Response

Vendor pending summaries in the standard cursor envelope

success
boolean
data
object