Sign in
Lightning

Lightning - List Invoices

List Lightning Network invoices for the given wallet.

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

Path parameters

walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

The wallet ID.

Request body

valueSatnumber

The invoice amount in satoshis

valueMsatstring

The invoice amount in millisatoshis

memostring

Optional description for the invoice

expirynumber

Optional expiration time in seconds

Response

OK

valueMsatstring

Amount in millisatoshis

valueSatnumber

Amount in satoshis

paymentHashstring

Payment hash of the invoice

invoicestring

The BOLT 11 encoded invoice string

walletIdstring

The public BitGo walletId to which this invoice belongs to

status'open' | 'settled' | 'canceled'

Current status of the invoice

expiresAtstring date-time

Expiration date in ISO format

createdAtstring date-time

Creation date in ISO format

updatedAtstring date-time

Last update date in ISO format

amtPaidMsatstring

Amount actually paid in millisatoshis (may be greater than valueMsat)

Changes

No recorded changes to this endpoint across all 17 revisions of this API.