{"id":35311307,"url":"https://github.com/jimasuen/lnbits-lightning-lnurl","last_synced_at":"2026-04-22T21:32:08.702Z","repository":{"id":195661834,"uuid":"688145225","full_name":"jimasuen/lnbits-lightning-lnurl","owner":"jimasuen","description":"Documentation on using LNbits API to pay lightning addresses and LNURL","archived":false,"fork":false,"pushed_at":"2024-04-28T17:19:36.000Z","size":37,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-28T18:28:29.375Z","etag":null,"topics":["curl","lightning","lightning-address","lightningaddress","lnbits","lnurl"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jimasuen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-06T18:39:48.000Z","updated_at":"2024-04-28T18:28:30.257Z","dependencies_parsed_at":null,"dependency_job_id":"b602b11c-c514-4702-b5d8-d0d08617b3a7","html_url":"https://github.com/jimasuen/lnbits-lightning-lnurl","commit_stats":null,"previous_names":["jimasuen/lnbits-lightning-lnurl"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jimasuen/lnbits-lightning-lnurl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimasuen%2Flnbits-lightning-lnurl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimasuen%2Flnbits-lightning-lnurl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimasuen%2Flnbits-lightning-lnurl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimasuen%2Flnbits-lightning-lnurl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jimasuen","download_url":"https://codeload.github.com/jimasuen/lnbits-lightning-lnurl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimasuen%2Flnbits-lightning-lnurl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32156472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-22T17:06:48.269Z","status":"ssl_error","status_checked_at":"2026-04-22T17:06:19.037Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["curl","lightning","lightning-address","lightningaddress","lnbits","lnurl"],"created_at":"2025-12-30T17:45:39.307Z","updated_at":"2026-04-22T21:32:08.696Z","avatar_url":"https://github.com/jimasuen.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# lnbits-lightning-lnurl\nDocumentation on using LNbits API to pay lightning addresses and LNURL\n\nLink to the relevant part of the LNbits API: \nhttps://demo.lnbits.com/docs#/Payments/api_payments_pay_lnurl_api_v1_payments_lnurl_post \n\nFor testing purposes, you can inspect your LNURL and lightning address and view the expected `description_hash` using this tool:\nhttps://lightninginspector.mysatoshikit.com/\n\n\n\n# STEPS:\n\n1. Decode LNURL using LNbits API. Skip this if you're paying a lightning address.\n\n\n    ```\n    curl -X 'POST'\n    https://your-lnbits-endpoint.com/api/v1/payments/decode\n    -H \"X-Api-Key: \u003cINVOICE KEY\u003e\"\n    -H \"Content-type: application/json\"\n    -d '{\"data\": \u003cLNURL\u003e}'\n    ```\n    \n    \n    Sample response:\n    \n    ```\n    {\n        \"domain\": \"https://decoded-lnurl-domain.com\"\n    }\n    ```\n\n\n2. Retrieve callback URL and metadata from lightning address or LNURL.\n\n\n    cURL for lightning address:\n    \n    \n    \n    ``` curl 'https://lightning-wallet-domain.com/.well-known/lnurlp/username' ```\n    \n    \n    OR\n    \n    \n    cURL for LNURL:\n    \n    \n    ``` curl 'https://decoded-lnurl-domain.com' ```\n    \n    \n    Sample response:\n    \n    ```\n    {\n        \"status\": \"OK\",\n        \"tag\": \"payRequest\",\n        \"commentAllowed\": 255,\n        \"callback\": \"https://lightning-wallet-domain.com/lnurlp/username/callback\",\n        \"metadata\": \"[[\\\"text/identifier\\\",\\\"username@lightning-wallet-domain.com\\\"],[\\\"text/plain\\\",\\\"Payment\\\"]]\",\n        \"minSendable\": 1000,\n        \"maxSendable\": 11000000000,\n        \"payerData\": {\n            \"name\": {\n                \"mandatory\": false\n            },\n            \"email\": {\n                \"mandatory\": false\n            },\n            \"pubkey\": {\n                \"mandatory\": false\n            }\n        }\n    }\n    ```\n\n\n\n3. Process payment using LNbits API:\n\n\n    ```\n    curl -X 'POST' \n      'https://your-lnbits-endpoint.com/api/v1/payments/lnurl'\n      -H \"X-Api-Key: \u003cADMIN KEY\u003e\"\n      -H 'Content-Type: application/json' \n      -d '{\n        \"description_hash\": \u003cstring\u003e,\n        \"callback\": \u003cstring\u003e,\n        \"amount\": \u003cint\u003e,\n        \"comment\": \u003cstring\u003e,\n        \"description\": \u003cstring\u003e\n    }'\n    ```\n    \n    \n    WHERE:\n    \n    `description_hash` = the sha256 hash of parsed metadata from decoded LNURL or lightning address  \n    \n    `callback` = callback url from decoded LNURL or lightning address  \n    \n    `amount` = amount to be paid; specified in millisats (sats to be paid * 1000)  \n    \n    `comment` = transaction note that will appear in receiver's lightning wallet (write what you want)  \n    \n    `description` = memo that will appear in your LNbits wallet (write what you want)  \n\n\n\n\n# Relevant links:\n\n1. On lightning addresses: https://github.com/andrerfneves/lightning-address/blob/master/README.md\n2. On LNURL payRequest: https://github.com/lnurl/luds/blob/luds/06.md\n3. Tool to view expected `description_hash` of parsed metadata from decoded LNURL or lightning address: https://lightninginspector.mysatoshikit.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimasuen%2Flnbits-lightning-lnurl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjimasuen%2Flnbits-lightning-lnurl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimasuen%2Flnbits-lightning-lnurl/lists"}