Ctrl+K

Lightning - Get Invoice

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

Get a single Lightning Network invoice by payment hash.

Path Parameters

  • coinstringRequired
    A lightning coin name.
    Example: lnbtc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • paymentHashstringRequired
    The payment hash of the invoice

200 Response

valueMsat string
Amount in millisatoshis
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
Current status of the invoice
Allowed values: open settled canceled
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 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