Skip to main content

ApiLNURLWithdraw

Serializable LNURL-withdraw representation for API responses.

typestringrequired

Marks the LNURL payload as an LNURL-withdraw response.

Possible values: [withdraw]

min objectrequired

Minimum withdrawable amount supported by the LNURL-withdraw endpoint.

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000
decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

max objectrequired

Maximum withdrawable amount supported by the LNURL-withdraw endpoint.

amountdecimalrequired

Decimal format of the amount, e.g. 1.5.

rawAmountbigintrequired

Raw base units as string, e.g. 1500000000000000000.

Possible values: Value must match regular expression ^[+-]?\d+$

Example: 1500000000000000000
decimalsintegerrequired

Token decimals, e.g. 18.

symbolstringrequired

Token ticker, e.g. STRK.

chainstringrequired

Chain identifier, e.g. STARKNET, BITCOIN, LIGHTNING.

params objectrequired

Raw LNURL-withdraw metadata and callback parameters.

tagstringrequired

Possible values: [withdrawRequest]

k1stringrequired
callbackstringrequired
domainstringrequired
minWithdrawableint64required
maxWithdrawableint64required
defaultDescriptionstringrequired
balanceCheckstring
payLinkstring
urlstringrequired

Original LNURL string.

ApiLNURLWithdraw
{
"type": "withdraw",
"min": {
"amount": "string",
"rawAmount": "1500000000000000000",
"decimals": 0,
"symbol": "string",
"chain": "string"
},
"max": {
"amount": "string",
"rawAmount": "1500000000000000000",
"decimals": 0,
"symbol": "string",
"chain": "string"
},
"params": {
"tag": "withdrawRequest",
"k1": "string",
"callback": "string",
"domain": "string",
"minWithdrawable": 0,
"maxWithdrawable": 0,
"defaultDescription": "string",
"balanceCheck": "string",
"payLink": "string",
"url": "string"
}
}