---
title: "Fetch lightning payments"
method: GET
path: "/api/v2/wallet/{walletId}/lightning/payment"
tags: ["Lightning"]
---

# 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

- `walletId` string, required

## Query parameters

- `status` 'in_flight' | 'settled' | 'failed'
- `limit` string, number
- `startDate` string, date-time
- `endDate` string, date-time
- `paymentHash` string
- `prevId` string

## Response `200`

OK

- GetPaymentsResponse
  - `payments` object[], required
    - `id` string, required
    - `paymentHash` string, required
    - `walletId` string, required
    - `txRequestId` string, required
    - `status` 'in_flight' | 'settled' | 'failed', required
    - `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` union
      - 'ERROR' — A non-recoverable error
      - 'INSUFFICIENT_BALANCE' — Insufficient channel outbound capacity
      - 'INSUFFICIENT_WALLET_BALANCE' — Insufficient custodial lightning balance for the customer's wallet
      - 'EXCESS_WALLET_BALANCE' — Excess custodial lightning balance for the customer's wallet
      - 'TIMEOUT' | 'NO_ROUTE' | 'INCORRECT_PAYMENT_DETAILS' | 'INVOICE_EXPIRED' | 'CANCELED' | 'FORCE_FAILED' | 'PAYMENT_ALREADY_SETTLED' | 'PAYMENT_ALREADY_IN_FLIGHT' | 'TRANSIENT_ERROR_RETRY_LATER'
    - `paymentPreimage` string
  - `nextBatchPrevId` string

## Other responses

- `400` — Bad Request
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/bitgo/apis/bitgo-api.md) · [All operations](https://skmtc.net/bitgo/apis/bitgo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitgo/bitgo-api/revisions/e445c15e5bee/schema)