Skip to main content
GET
One vendor's pending payout items (drill-down)

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.

Path Parameters

vendorId
string
required

The vendor whose pending items to list

Query Parameters

startDate
string
required

Window start (YYYY-MM-DD in the shop timezone, or ISO 8601)

endDate
string
required

Window end (YYYY-MM-DD in the shop timezone, or ISO 8601); a future date clamps to now; at most 12 months after startDate

first
integer

Number of items to return (orderDate ascending)

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

Cursor for forward pagination

last
integer

Number of items to return (backward pagination)

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

Cursor for backward pagination

Response

Summary header over the full window plus the page of items

success
boolean
data
object

The summary node fields (vendorName, vendorId, amount, currency, fromDate, toDate, payoutMethod, itemsCount) plus edges/pageInfo