LNURL

Well-known endpoint

Returns the LNURL payRequest for this LN Address (username). The returned payload contains information allowing the payer to generate an invoice. See LUDS-06

get/.well-known/lnurlp/{username}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

usernamestring required

Response

Found

allowsNostrboolean required

Nostr enabled

callbackstring required

The URL from LN SERVICE to accept the pay request

commentAllowedinteger required

Optional number of characters accepted for the comment query parameter on subsequent callback, defaults to 0 if not provided. (no comment allowed). See https://github.com/lnurl/luds/blob/luds/12.md

maxSendableinteger required

Max amount in milli-satoshis LN SERVICE is willing to receive

metadatastring required

Metadata json which must be presented as raw string here, this is required to pass signature verification at a later step

minSendableinteger required

Min amount in milli-satoshis LN SERVICE is willing to receive, can not be less than 1 or more than maxSendable

nostrPubkeystring nullable

Nostr public key

tagstring required

Type of LNURL

Example response

{
  "callback": "https://numeraire.tech/lnurlp/dario_nakamoto/callback",
  "commentAllowed": 255,
  "maxSendable": 1000000000,
  "metadata": "[[\"text/plain\",\"dario_nakamoto never refuses sats\"],[\"text/identifier\",\"dario_nakamoto@numeraire.tech\"]]",
  "minSendable": 1000,
  "nostrPubkey": "d9c2ec59a98c...",
  "tag": "payRequest"
}

Changes

No recorded changes to this operation across all 24 revisions of this API.