Sign in
Invoices

Generate a new invoice

Changed on

Returns the generated invoice for the selected wallet.

post/v1/invoices

Request

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

Request body

amount_msatinteger required

Amount in millisatoshis

descriptionstring nullable

Description of the invoice. Visible by the payer

expiryinteger nullable

Expiration time in seconds

wallet_idstring uuid nullable

Wallet ID to receive into. Required by admin endpoints; derived from the path on wallet-scoped endpoints.

Response

Invoice Created

amount_msatinteger nullable

Amount requested in millisatoshis.

amount_received_msatinteger nullable

Amount received in millisatoshis.

created_atstring date-time required

Date of creation in database

descriptionstring nullable

Description

fee_msatinteger nullable

Fees paid. Populated when a new channel is opened to receive the funds.

idstring uuid required

Internal ID

ledger'Lightning' | 'Internal' | 'Onchain' required

The ledger a transaction settles on.

ln_address_idstring uuid nullable

Lightning Address. Populated when invoice is generated as part of the LNURL protocol

payment_timestring date-time nullable

Payment time

status'Pending' | 'Settled' | 'Expired' required

Lifecycle status of an invoice.

timestampstring date-time required

Date of creation on the LN node

updated_atstring date-time nullable

Date of update in database

wallet_idstring uuid required

Wallet ID

Example response

{
  "ln_invoice": {
    "bolt11": "lnbcrt1m1png24kasp5...",
    "expiry": 3600,
    "min_final_cltv_expiry_delta": 10,
    "payee_pubkey": "02086a3f5b67ac4c43...",
    "payment_hash": "b587c7f76339e3fb87ad2b...",
    "payment_secret": "019a32e03bb375a42bc..."
  }
}

Changes

  • d0b29ec67614Revision changes
    • breaking

      removed the required property from the response with the status

  • c3abc288bbc3Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      removed from the response property oneOf list for the response status