marketplace

GET /v1/marketplace/vendor/payouts

What has been paid out, and what is being held.

All marketplace endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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/payouts \
  -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

⭐ This is what makes a HELD payout something a seller can act on rather than money that silently did not arrive. docs/82 §7a is explicit that an unverified vendor is told exactly why and what to do, and a hold with no surface is the same as no hold at all from where they are standing — they simply were not paid. `hold_reason` is a NAMED code rather than prose, so a console can render an instruction per reason: "finish your verification" is a different action from "your balance is below this rail's minimum and is rolling over to next week". `external_ref` is empty for account credit, which never leaves the platform — a real distinction rather than a missing value.

Parameters

NameTypeRequiredWhat it is
cursor (query)stringNoOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNoMaximum items to return (page size).

Response

NameTypeRequiredWhat it is
dataMarketplacePayout[]Yes
pagePageMetaYes

Errors this endpoint can return

401