Create a lightning address
Creates a lightning address (identifier@host) for a customer on one of your verified domains. If the customer already holds the identifier, the existing address is returned.
Authorizations
Your workspace client id.
All calls must include four headers:
X-Auth-Client— your workspace client idX-Auth-Timestamp— Unix secondsX-Auth-Nonce— 16-byte random hexX-Auth-Signature— hex(HMAC-SHA256({client_id}:{timestamp}:{nonce}:{raw_body}, client_secret))
The playground computes the timestamp, nonce and signature for you.
Your sandbox client secret. The playground uses it to sign the request in your browser and removes it before the request is sent. Never send your client secret as a header in your own integration.
Body
Customer that owns the address. Required: an empty value is rejected as an invalid customer_id.
A verified domain you own.
Local part; lower-cased before checking.
^[a-z0-9._-]{1,64}$Maximum payable amount in sats; must be at least min_sendable_sat.
x >= 1Minimum payable amount in sats; must be positive.
x >= 1Advertise NIP-57 zap support.
Maximum payer comment length. 0 (the default) disables comments.
0 <= x <= 1000Text shown to payers of this address.
500Standard base64 image, at most 64 KiB encoded.
65536Response
Address already exists; data is the existing address
Successful responses are wrapped in this envelope, and so are errors a handler answers itself (request body and field validation, some not-found and conflict cases, ORG_NOT_ACTIVE): success is false and error carries a code and message. Errors raised by authentication and by the services behind a handler are a Problem instead.
true on success
When the response was written.
The payload; its shape is given per operation. Omitted when there is none.
Human-readable summary; omitted when empty.
List metadata. Page lists set page, per_page, total and total_pages; offset and cursor lists set limit, offset, has_more and next_cursor. Zero and empty fields are omitted, and metadata is absent when nothing is set.
Set on error envelopes: the request's correlation id (req_ followed by a UUID), the same value as the X-Correlation-ID response header. Quote it to support.