Tizondocs
ReferenceRevenue

Pay earnings out

POST
/v1/revenue/payouts

Pays earnings out. Omit amount to pay out everything payable.

method says where (adr/0056). lightning, the default, pays the account's Lightning address in satoshis worth the amount when the invoice is made; the routing fee is Tizon's, and the address receives the whole amount. crypto sends the stablecoin and network of the account's crypto_address, less the network fee, which is quoted when the payout is asked for and shown as network_fee; GET /v1/revenue/payout_quote shows it beforehand. Lightning payouts start at $1.00 and stablecoin payouts at $10.00.

What is payable is the Revenue Centre's balance less any overdraft the wallet has drawn: Tizon never sends out money the account owes back.

The payout is taken from the balance at once, so it cannot be spent twice, and comes back awaiting_approval: Tizon reviews every payout by hand and sends it within two business days (adr/0055). Once approved it is pending while it is sent, and ends succeeded, or failed with the money returned to the Revenue Centre; payout.succeeded and payout.failed say which. A payout turned down fails with failure_reason rejected, and its money is returned the same way. Payouts may be off on Tizon's side (503 payouts_unavailable), which never touches what has been earned.

Authorization

ApiKey
AuthorizationBearer <token>

An account API key, sent as Authorization: Bearer tz_live_…. The prefix selects the mode: tz_test_ for sandbox, tz_live_ for real money.

In: header

Header Parameters

Idempotency-Key*string

A client-generated key, unique per intended operation, that makes this request safe to retry. The same key returns the original response; the same key with a different request is rejected. Missing: 400 idempotency_key_required.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/revenue/payouts" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "object": "payout",  "livemode": true,  "status": "awaiting_approval",  "amount": {    "amount": 1450,    "currency": "USD"  },  "method": "lightning",  "lightning_address": "string",  "crypto_address": null,  "network_fee": null,  "transaction_hash": "string",  "payment_hash": "string",  "amount_sats": 0,  "failure_reason": "string",  "rejection_reason": "string",  "created_at": "2019-08-24T14:15:22Z",  "resolved_at": "2019-08-24T14:15:22Z"}