API Reference

Perform LNURL-Withdraw to accept NFC payments (i.e. BoltCard)

📘

Steps to perform LNURL-Withdraw

  1. Client calls this route with params bpt_id (BPT you want to receive payment), amount_msat (amount you're withdrawing/being paid), and tip_amount_msat (amount being tipped optional)
  2. Client then sends this json via the websocket
    {
        "lnurl": string,    // lnurlw
        "bolt11ToCancel": string     // optional bolt11 to be canceled
    }
    
  3. Client will be notified when the lnurlw has been withdrawn via websocket message
Language
Credentials
Header
Click Try It! to start a request and see the response here!