marketplace
POST /v1/marketplace/vendor/payout-methods
Propose a destination to be paid at.
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 POST https://api.zinndigital.com/v1/marketplace/vendor/payout-methods \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "rail": <string> }'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
docs/82 §7c. The row is created **unverified** and can receive nothing: only staff verification makes it payable, and then only after the 48-hour cooling-off. ⛔⛔ **A change of destination is a new row, never an edit** — there is deliberately no endpoint that changes `destination` on an existing one. §7c: *"Change of payout details is the account-takeover cash-out route, and must be treated as one."* Editing a verified row would keep its verified state and its long-expired hold while pointing the money somewhere nobody looked at. ⭐ Re-adding a destination the seller already has returns the existing row rather than minting a second one — otherwise "change it and change it back" resets the cooling-off clock in two requests. ⛔ The **network** is its own field, not part of the address. Sending USDT TRC20 to a BEP20 address loses the money irrecoverably, so the same address on two networks is two destinations, each earning its own proof and its own hold.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
rail | string | Yes | — |
destination | string | No | Empty for account credit, which has nowhere to send. |
network | string | No | — |
label | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
rail | string | Yes | — |
rail_name | string | Yes | — |
destination | string | Yes | ⛔ **Masked, always.** Enough to recognise which account this is, never enough to reproduce it. The whole value never leaves the engine on a read path. |
network | string | Yes | ⛔ Its own field, never folded into the address. Sending USDT TRC20 to a BEP20 address loses the money irrecoverably (docs/82 §7b), so the network is part of the destination's id… |
label | string | Yes | — |
state | MarketplacePayoutMethodState | Yes | Where one destination is in its own verification (docs/82 §7c). `retired` rows are kept rather than deleted — a payout that went there is explained by them. |
proof_kind | MarketplacePayoutProofKind | Yes | How ownership of the destination was shown. ⛔ Crypto is the honest exception and is recorded as one: docs/82 §7c states that *no document can prove wallet ownership*, so a signe… |
rejection_reason | string | No | — |
is_default | boolean | Yes | — |
verified_at | string | No | — |
hold_until | string | No | docs/82 §7c's 48-hour cooling-off on the **first** payout to this destination — long enough for the change notice to land, short enough that a seller who genuinely changed bank… |
permitted_proof_kinds | MarketplacePayoutProofKind[] | Yes | — |
Errors this endpoint can return
401 · 404 · 422