Create Lightning Address

Lightning Addresses are created via lnurlpay objects

The same /lnurlp endpoint is used, but with addition of lnurlp_identifier and custy_domain_id

In order to use YOUR domain, you must implement the following redirect:

<yourdomain>/.well-known/lnurlp/* -> api.lnpay.co/.well-known/<custy_domain_id>/lnurlp/*

Create Lightning Address

POST https://<yourdomain>/v1/wallet/:wallet_key/lnurlp

A Lightning Address is basically a wrapper around the LNURL-pay functionality.

Path Parameters

NameTypeDescription

wallet_key*

String

e.g. waka_XXX

Request Body

NameTypeDescription

lnurlp_identifier*

String

e.g. myuser

do not include domain name

custy_domain_id*

String

Domain ID e.g. cdom_xxx

lnurlp_minSendable_msat

Integer

e.g. 1000

lnurlp_maxSendable_msat

Integer

e.g. 100000

lnurlp_short_desc

String

Description for invoices

{
    "id": "lnurlp_MV3guVwAjuFIgf9v3Z",
    "created_at": 1641914620,
    "updated_at": 1641914620,
    "user_label": "Base lnurl-pay link",
    "lnurl_encoded": "LNURL1DP68GUP69UHKCMNSV9UJUMR0VDSKCW3CXYCNZTMKXYHHWCTVD3JHGTMHV94KCUZLVEFNYUZ2FPHK5VZR0Q68SU26XDP5XNM2V355XTMVDE6HYMRS9AKXUATJD3C97N2KXDNH24NHG94823JFVANRJA3NTGMJA6YY",
    "lnurl_decoded": "http://lnpay.local:8111/v1/wallet/waklp_fS2pJHoj0Cx4xqZ3CCOjdiC/lnurlp/lnurlp_MV3guVwAjuFIgf9v3Z",
    "lnurlp_minSendable_msat": 1000,
    "lnurlp_maxSendable_msat": 10000000,
    "lnurlp_short_desc": "LNURL PAY (via LNPay.co)",
    "identifier": "username",
    "statusType": {
        "type": "lnurl",
        "name": "lnurl_active",
        "display_name": "LNURL Active"
    },
    "custyDomain": {
        "domain_name": "sats.me",
        "display_name": "My LN Address Domain"
    }
}

Last updated