Skip to main content
Three reads, all scoped to your vendors: your marketplace identifier comes from your API key and cannot be supplied in the request.

List your vendors

200
The list does not carry balances: that would be one query per vendor. Read a vendor’s detail for its balances.

Read a vendor

200
array
One entry per currency. A vendor that was created but never paid returns []: that is a nominal state, and the response stays 200.
number
The available balance: this is the only amount that can be paid out.
number
Funds credited but not yet matured. They cannot be paid out, but they can still be seized by a refund.
number
Funds committed to a payout in flight. Do not confuse them with pending_balance: these are two different states.
string | null
The date on which the next pending credit becomes available. null when nothing is pending.

Read a vendor’s history

200
This list is paginated by page number, not by cursor: it therefore returns no next_cursor.
Read the two dates together:

Errors common to all three reads