Ctrl+K

Fetch lightning invoices

get/api/v2/wallet/{walletId}/lightning/invoices

This API call is used to fetch previously created lightning invoices associated with a given walletId.

Path Parameters

  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • statusstring
    The status of lightning invoices to search for
  • limitnumber
    Limit the number of search results. Default 25
  • startDatestring<date-time>
    The start date for range of lightning invoices to search for
    Example: "2022-11-08T00:00:00.000Z"
  • endDatestring<date-time>
    The end date for range of lightning invoices to search for
    Example: "2022-11-09T00:00:00.000Z"

200 Response

invoices array[object]
paymentHash string
The payment hash of the invoice
Example: 63d9ce82e09d16761a85116ed8b65407db4fb22f85d03573de09c480f2c6d175
value number
The value of the invoice in satoshis
Example: 50000
expiresAt string
ISO-8601 string representing when the invoice will expire
Example: 2022-04-01T18:46:24.677Z
createdAt string
ISO-8601 string representing when the invoice was created
Example: 2022-04-01T17:46:24.677Z
updatedAt string
ISO-8601 string representing when the invoice was updated last
Example: 2022-04-01T18:16:24.677Z
status string
The status of the invoice
Allowed values: open settled canceled
walletId string
The wallet to which this invoice belongs
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
amtPaidSats number
The actual amount paid to the invoice in satoshis
Example: 50000

400 Response

One of
error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code