Sign in
Invoices

List invoices

Changed on

Returns all the invoices given a filter

get/v1/invoices

Request

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

Query parameters

limitinteger nullable

Total amount of results to return

offsetinteger nullable

Offset where to start returning results

idsstring[] nullable

List of IDs

wallet_idstring uuid nullable

Wallet ID. Automatically populated with your ID

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

Lifecycle status of an invoice.

Status

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

The ledger a transaction settles on.

Ledger

order_by'CreatedAt' | 'PaymentTime' | 'UpdatedAt'

Field to order invoices by.

Order by

order_direction'Asc' | 'Desc'

Direction of result ordering for list endpoints.

Direction of the ordering of results

Response

Success

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