Ctrl+K

Lightning - List Payments

get/api/v2/{coin}/wallet/{walletId}/lightning/payment

List Lightning Network payments for the given wallet.

Path Parameters

  • coinstringRequired
    A lightning coin name.
    Example: lnbtc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • PaymentQueryobject
    • statusstring
      Filter payments by status
      Enum: in_flight settled failed
    • limitstring
      Maximum number of payments to return
    • startDatestring<date-time>
      Start date for payment query in ISO format
    • endDatestring<date-time>
      End date for payment query in ISO format

200 Response

Array of
paymentHash string
Payment hash of the payment
walletId string
The public BitGo walletId to which this payment belongs
txRequestId string
Transaction request ID
status string
Current status of the payment
Allowed values: in_flight settled failed
invoice string
The BOLT 11 encoded invoice string
feeLimitMsat string
Fee limit in millisatoshis
destination string
Destination of the payment
updatedAt string <date-time>
Last update date in ISO format
createdAt string <date-time>
Creation date in ISO format
amountMsat string
Amount in millisatoshis
feeMsat string
Fee in millisatoshis
failureReason string
Reason for payment failure: * TIMEOUT - Payment timed out * NO_ROUTE - No route found * ERROR - Non-recoverable error * INCORRECT_PAYMENT_DETAILS - Payment details are incorrect * INSUFFICIENT_BALANCE - Insufficient channel outbound capacity * INSUFFICIENT_WALLET_BALANCE - Insufficient custodial lightning balance * EXCESS_WALLET_BALANCE - Excess custodial lightning balance * INVOICE_EXPIRED - Invoice has expired * CANCELED - Payment was canceled
Allowed values: TIMEOUT NO_ROUTE ERROR INCORRECT_PAYMENT_DETAILS INSUFFICIENT_BALANCE INSUFFICIENT_WALLET_BALANCE EXCESS_WALLET_BALANCE INVOICE_EXPIRED CANCELED
paymentPreimage string
Payment preimage

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