Ctrl+K

Fetch lightning invoices

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

This API call is used to fetch current lightning invoices which are used for requesting and receiving payments over the lightning network.

Path Parameters

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

Query Parameters

  • statusstring
    Enum: open settled canceled
  • limitstring<number>
  • startDatestring<date-time>
  • endDatestring<date-time>

200 Response

Array of
valueMsat string <number>required
paymentHash string required
invoice string required
walletId string required
status string required
Allowed values: open settled canceled
expiresAt string <date-time>required
createdAt string <date-time>required
updatedAt string <date-time>required
amtPaidMsat string <number>
The number of millisats actually paid to this invoice, this may be greater than the amount requested by the invoice, since lightning allows overpaying (but not underpaying) invoices.

400 Response

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

404 Response

name string required
Allowed value: InvalidWalletId
context object required
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
error string required
Human-readable error message
requestId string required
Client request id

500 Response

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