Skip to main content
POST

Authorizations

​
X-Auth-Client
string
header
required

Your workspace client id.

All calls must include four headers:

  • X-Auth-Client — your workspace client id
  • X-Auth-Timestamp — Unix seconds
  • X-Auth-Nonce — 16-byte random hex
  • X-Auth-Signature — hex(HMAC-SHA256( {client_id}:{timestamp}:{nonce}:{raw_body}, client_secret))

The playground computes the timestamp, nonce and signature for you.

​
X-Playground-Client-Secret
string
header
required

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

application/json
​
customer_id
string<uuid>
required

Customer the link serves. Required: an empty value is rejected as an invalid customer_id.

​
domain_id
string<uuid>
required

A domain you own; must not be disabled.

​
max_withdraw_sat
integer<int64>
required

Maximum claim in sats; at least min_withdraw_sat. This amount is reserved from your balance when the link is issued.

Required range: x >= 1
​
min_withdraw_sat
integer<int64>
required

Minimum claim in sats.

Required range: x >= 1
​
ttl_seconds
integer<int32>
required

Link lifetime in seconds. Must be positive.

Required range: x >= 1
​
description
string

Text shown to the person withdrawing.

Maximum string length: 500
​
disposable
boolean

Single-use link.

Response

Created

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.

​
success
boolean
required

true on success

​
timestamp
string<date-time>
required

When the response was written.

​
data
object

The payload; its shape is given per operation. Omitted when there is none.

​
error
object
​
message
string

Human-readable summary; omitted when empty.

​
metadata
object

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.

​
request_id
string

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.