Pay out everything you are owed, to your registered address
POST/payouts
Sends all of your accrued integrator fees (GET /payouts/accrued) to your registered
payout address, from Treasures' payout treasury. You choose nothing: the amount is what you are
owed, the destination is the address Treasures registered, and the body must be empty (or {}).
Idempotency-Key is required. A key is yours forever: repeating it returns the payout it
first created, whatever its status, including failed. To try again after a failure, send a
new key. Only one payout can be in progress at a time.
Limits: at least minimum_usd, at most maximum_usd (larger balances are paid out by
Treasures on request), one payout per cooldown window, and none for a while after your payout
address changes. GET /payouts/accrued reports all of them, including next_eligible_at.
202 means the transfer was sent or is being sent. Poll GET /payouts/{payoutId} until
status is paid (or failed, in which case the fees are owed to you again).
Requires your general (tik_) key; a reporting key is refused.
Request
Responses
- 200
- 202
- 400
- 401
- 403
- 409
- 422
- 429
- 503
The original payout, replayed for an Idempotency-Key you already used.
Payout created and sent (or being sent).
missing_idempotency_key, invalid_idempotency_key, or a non-empty body.
Missing, malformed or unknown X-API-Key.
insufficient_scope, key_revoked or integrator_suspended.
payout_in_progress (with payout_id), payout_cooldown / address_hold (with retry_after, Unix seconds, and a Retry-After header), payout_address_missing (ask Treasures to register one), nothing_to_pay.
below_minimum (with amount_usd, minimum_usd) or requires_review (with amount_usd, maximum_usd; Treasures pays balances this large on request).
Sliding window exceeded: per-IP or per-(IP, wallet), plus a per-organisation bucket (shared across all of your keys) whenever a valid X-API-Key is presented. Retry-After header carries delta-seconds.
payouts_unavailable: payouts are paused or cannot be made right now. Retry later.