Tizondocs
ReferenceRevenue

Set where earnings are paid

PUT
/v1/revenue/payout_address

The Lightning address payouts go to, such as you@getalby.com. Checked for shape and for pointing somewhere public; whether anything answers there is found out by the first payout. A payout already asked for keeps the address it was asked for with. Moves no money, so it takes no Idempotency-Key.

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

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

curl -X PUT "https://example.com/v1/revenue/payout_address" \  -H "Content-Type: application/json" \  -d '{    "lightning_address": "earnings@getalby.com"  }'
{  "object": "payout_address",  "lightning_address": "string",  "updated_at": "2019-08-24T14:15:22Z"}