REST API›Wallet & Transact›Lightning

GET

Lightning - List Invoices

List Lightning Network invoices for the given wallet.

Path Params

  • walletId string required
    The wallet ID.

    matches ^[0-9a-f]{32}$

Body Params

object

Create invoice request. Provide exactly one of valueMsat or valueSat
  • valueSat number
    The invoice amount in satoshis
  • valueMsat string
    The invoice amount in millisatoshis
  • memo string
    Optional description for the invoice
  • expiry number
    Optional expiration time in seconds

Responses

200
OK

Response Body

array of objects

  • valueMsat string
    Amount in millisatoshis
  • valueSat number
    Amount in satoshis
  • paymentHash string
    Payment hash of the invoice
  • invoice string
    The BOLT 11 encoded invoice string
  • walletId string
    The public BitGo walletId to which this invoice belongs to
  • status string enum
    Current status of the invoice
    opensettledcanceled
  • expiresAt string date-time
    Expiration date in ISO format
  • createdAt string date-time
    Creation date in ISO format
  • updatedAt string date-time
    Last update date in ISO format
  • amtPaidMsat string
    Amount actually paid in millisatoshis (may be greater than valueMsat)
400
Bad Request

Response Body

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