---
title: "Lightspeed Payments Data"
method: GET
path: "/f/v2/business-location/{businessLocationId}/lightspeed-payments"
tags: ["FinancialV2"]
---

# Lightspeed Payments Data

`GET /f/v2/business-location/{businessLocationId}/lightspeed-payments`

Returns Lightspeed Payments fee and surcharge data for a business location for a specified date range. Results are queried and sorted based on the specified dateType.

Note: Will only return sales created after migration from iKentoo 2.0 to Lightspeed K-Series. See [this article](https://k-series-support.lightspeedhq.com/hc/en-us/articles/360056758333-Upgrading-to-K-Series-from-iKentoo-2-0) for more details.

## Path parameters

- `businessLocationId` integer, required

## Query parameters

- `from` string, date-time, required
- `to` string, date-time
- `pageSize` integer
- `offset` integer — The pagination offset.
- `sortDirection` 'ASC' | 'DESC' — The direction to sort the results.
- `dateType` 'CREATED' | 'MODIFIED' — The date used when querying and sorting results.
- `status` FinancialApiLSPaymentStatus[]

## Response `200`

successful operation

- FinancialApiLSPaymentsDto
  - `payments` FinancialApiLSPayment[] — List of requested payments.
    - `accountFiscId` string — The account identifier.
    - `lightspeedPaymentId` string — Unique identifier assigned by Lightspeed to the payment, derived from Adyen's PSP reference. This alphanumeric code uniquely identifies each payment or modification request, including refunds. For more information, see Adyen's documentation: https://help.adyen.com/knowledge/payments/payment-basics/what-is-a-psp-reference-number
    - `uuid` string — The internal UUID of the payment. This value may not be unique in scenarios involving Pay-at-Table, partial, or split payments, where multiple payment transactions can share the same reference and/or POS Order Id For a guaranteed unique identifier for each Lightspeed Payments transaction, use the `lightspeedPaymentId` field which is based off Adyen PSP ID.
    - `reference` string — The alphanumeric reference of the payment.
    - `status` 'CAPTURED' | 'DISPUTED' | 'PARTIALLY_REFUNDED' | 'REFUNDED' — The statuses for a Lightspeed Payments transaction.
    - `createdDate` string, date-time — The date and time the payment was created.
    - `captureDate` string, date-time — The date and time the payment was captured.
    - `modificationDate` string, date-time
    - `fees` FinancialApiCurrencyAmount
      - `value` string — The amount in dollars.
      - `currency` string — The currency code.
    - `surcharge` FinancialApiCurrencyAmount
      - `value` string — The amount in dollars.
      - `currency` string — The currency code.
  - `pageSize` integer — Size of the returned collection.
  - `offset` integer — Offset of the first item returned in the collection.
  - `nextOffset` integer — Next offset to get next page of data based off current pageSize and offset, if available.

## Other responses

- `400` — Bad Request - Invalid request parameters or format.

---

[API](https://skmtc.net/lightspeed/apis/lightspeed-restaurant-k-series-api.md) · [All operations](https://skmtc.net/lightspeed/apis/lightspeed-restaurant-k-series-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightspeed/lightspeed-restaurant-k-series-api/revisions/96f04e4e3f61/schema)