Generate Invoice

The Generate Invoice endpoint is unique in that it returns an LnTx object vs a wtx object. The LnTx object in this case represents an unpaid invoice. To check the status of this - use the /lntx

post
PostWalletInvoice
https://api.lnpay.co/v1/wallet/:wallet_key/invoice
Creating an invoice returns the LNPay representation of a BOLT11 invoice - the LnTx object
Request
Response
Request
Path Parameters
wallet_key
required
string
wal_ for server side
waki_ for client side
Body Parameters
passThru
optional
object
JSON object. you can reference these parameters later via webhooks, etc. Good for ticket # or a certain ID
description_hash
optional
string
base64 encoded hash of payment. If this is provided, memo will be ignored.
memo
optional
string
​
expiry
optional
integer
seconds, defaults to 86400 (1 day)
num_satoshis
required
integer
​
Response
201: Created
This returns an LnTx object 
# LnTx Object
{
    "id": "lntx_ztkK7XxfqCq3ihmhJiUhnR",
    "created_at": 1582462172,
    "dest_pubkey": "033868c219bdb51a33560d854d500fe7d3898a1ad9e05dd89d0007e11313588500",
    "payment_request": "lnbc200n1p09yaxupp5r7ckx99n00d2a7g8xtr8wup57w82t827kkeujsdgjyn45cjmym7sdp623jhxapqd9h8vmmfvdjjqenjdakjq5r0wd6x6ctwyppk7mrvv43hg6t0dccqzpgxqyz5vqsp5gyfwnrqnkyvxxgpww0vwsl8tfe524ggr5kngr8n8fn4vt9xl5ggs9qy9qsq42vwx9dh2n3ggrlgwqqxqq77detywruhv2s558uk3vfrumgmjfhs3y8hwtgxe7cx6svg4pr87qzfg8mgawsveqe6wn0te9d3h02fm4spxtzy5s",
    "r_hash_decoded": "1fb16314b37bdaaef90732c6777034f38ea59d5eb5b3c941a891275a625b26fd",
    "memo": "Test invoice from Postman Collection",
    "description_hash": null,
    "num_satoshis": 20,
    "expiry": 86400,
    "expires_at": 1582548572,
    "payment_preimage": null,
    "settled": 0,
    "settled_at": null,
    "is_keysend": null,
    "custom_records": null,
    "passThru": {
        "wallet_id": "wal_czDztN5eJ4r5sJ",
        "userDefined": {
            "ticketId": "556"
        }
    }
}
To check if an invoice has been paid or not use the LnTx endpoint ​
cURL
Node.js
Python
JavaScript
cURL
curl -u sak_XXXXXXX: \
-H "Content-Type: application/json" \
-X POST \
-d '{"num_satoshis":5, "memo":"Test invoice from the docs","passThru":" {\"ticketId\":\"556\"} "}' \
https://api.lnpay.co/v1/wallet/wal_XXXX/invoice
Node.js
const lnpay = LNPay({
  secretKey: 'sak_XXXXX',
  walletAccessKey: 'wal_XXXXX',
});
​
const invoice = await lnpay.generateInvoice({
  num_satoshis: 100,
  passTru: {
    order_id: '100',
  },
  description_hash: 'MTIzNDY1Nzg5N...',
  memo: 'Invoice memo.',
  expiry: 86400, // 1 day
});
Python
lnpay_py.initialize('sak_XXXXXXX')
from lnpay_py.wallet import LNPayWallet
​
my_wallet = LNPayWallet('wal_XXXXX')
invoice_params = {
    'num_satoshis': 2,
    'memo': 'Tester'
}
invoice = my_wallet.create_invoice(invoice_params)
JavaScript
LNPay.Initialize('pak_XXXXXXX');
​
let myWallet = new LNPayWallet('waki_XXXXXX');
let invoiceParams = {"num_satoshis":2,"memo":"Tester"};
myWallet.createInvoice(invoiceParams,
    function(result) {
      console.log(result);
    }
);
See the Access Keys section on how to define wallet_key

API - Previous

Wallet Send / Receive

Pay Invoice

Last updated 2 weeks ago

Generate Invoice

postPostWalletInvoice

post
PostWalletInvoice