ApiLNURL

Serializable LNURL representation for API responses.

type stringrequired

Serializable LNURL representation for API responses.

Possible values: [pay, withdraw]

pay

min objectrequired

Minimum payable amount supported by the LNURL-pay 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 payable amount supported by the LNURL-pay 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.

commentMaxLengthintegerrequired

Maximum comment length accepted by the LNURL-pay endpoint.

shortDescriptionstring

Short human-readable description of the payee, when provided by the LNURL service.

longDescriptionstring

Longer human-readable description of the payee, when provided by the LNURL service.

iconstring

Optional icon for the payee, usually encoded as a data URL.

params objectrequired

Raw LNURL-pay metadata and callback parameters.

tagstringrequired

Possible values: [payRequest]

callbackstringrequired

domainstringrequired

minSendableint64required

maxSendableint64required

metadatastringrequired

decodedMetadataarray[]required

commentAllowedintegerrequired

urlstringrequired

Original LNURL string.

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.

ApiLNURL

{
  "type": "pay",
  "min": {
    "amount": "string",
    "rawAmount": "1500000000000000000",
    "decimals": 0,
    "symbol": "string",
    "chain": "string"
  },
  "max": {
    "amount": "string",
    "rawAmount": "1500000000000000000",
    "decimals": 0,
    "symbol": "string",
    "chain": "string"
  },
  "commentMaxLength": 0,
  "shortDescription": "string",
  "longDescription": "string",
  "icon": "string",
  "params": {
    "tag": "payRequest",
    "callback": "string",
    "domain": "string",
    "minSendable": 0,
    "maxSendable": 0,
    "metadata": "string",
    "decodedMetadata": [
      "string"
    ],
    "commentAllowed": 0,
    "url": "string"
  }
}