marketplace
GET /v1/marketplace/vendor/ledger
What the seller is owed, and what is still being held.
Authentication
Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/marketplace/vendor/ledger \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
"Funds are held securely by Zinn® until the buyer accepts delivery" (docs/82 §1) is a promise to two people, and the seller is the one who needs to watch it — a balance they cannot see is indistinguishable from not being paid. The three balance figures are computed over every entry by the database, not summed from data. They are kept separate rather than netted because they answer different questions: pending is what no buyer has accepted yet, released is what the next weekly payout run will pay, paid is history.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
cursor (query) | string | No | Opaque cursor from a previous page's page.next_cursor. |
limit (query) | integer | No | Maximum items to return (page size). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | MarketplaceLedgerEntry[] | Yes | — |
page | PageMeta | Yes | — |
balance | MarketplaceLedgerBalance | Yes | Computed by the database over EVERY entry, never summed from the page above it — a paginated list summed in a client is wrong from the second page onward, and wrong about the… |
Errors this endpoint can return
401