ReferenceRevenue
Preview a payout
What POST /v1/revenue/payouts would pay out by method right now: everything
payable, the network fee taken from it, what arrives, and where. Asks the rail
for the fee, so it can be 502 rail_unavailable; it moves nothing and reserves
nothing, and the fee is quoted again when the payout is asked for. No address
for that method is 409 payout_address_required.
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
Query Parameters
method?string
Which way to pay out; lightning when left out.
Default
"lightning"Value in
- "lightning"
- "crypto"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/revenue/payout_quote"{ "object": "payout_quote", "livemode": true, "method": "lightning", "amount": { "amount": 1450, "currency": "USD" }, "network_fee": { "amount": 1450, "currency": "USD" }, "amount_received": { "amount": 1450, "currency": "USD" }, "minimum": { "amount": 1450, "currency": "USD" }, "lightning_address": "string", "crypto_address": null}