Ctrl+K

Fetch lightning payments

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

This API call is used to fetch current lightning payments over the lightning network.

Path Parameters

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

Query Parameters

  • statusstring
    Enum: in_flight settled failed
  • limitstring<number>
  • startDatestring<date-time>
  • endDatestring<date-time>

200 Response

Array of
paymentHash string required
walletId string required
txRequestId string required
status string required
Allowed values: in_flight settled failed
invoice string required
feeLimitMsat string <number>required
destination string required
updatedAt string <date-time>required
createdAt string <date-time>required
amountMsat string <number>required
feeMsat string <number>
failureReason string
Allowed values: TIMEOUT NO_ROUTE ERROR INCORRECT_PAYMENT_DETAILS INSUFFICIENT_BALANCE INSUFFICIENT_WALLET_BALANCE EXCESS_WALLET_BALANCE INVOICE_EXPIRED CANCELED
paymentPreimage string

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