---
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`

## Request

- Base URL: `https://api.trial.lsk.lightspeed.app`
- URL: `https://api.trial.lsk.lightspeed.app/f/v2/business-location/{businessLocationId}/lightspeed-payments`
- Auth: OAuth 2
  - Authorization code: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth`
  - Token URL: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token` scopes: `financial-api`

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.

Warning: This endpoint may not return all Lightspeed Payments transactions. Standalone (non-integrated) terminal payments are not supported: in standalone mode the POS is never made aware of the transaction,
so no POS metadata exists to link the payment back to an account. Order Anywhere transactions may also be omitted when no POS metadata is generated; we are aware of this and are working on an improvement.

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 POS-generated alphanumeric payment reference. Only present for terminals directly integrated with the POS, where the payment terminal supplies a POS reference. Payments taken on cloud-connected terminals (CLOUD_FS) do not generate this value, and the field is omitted from their payment data. In this case, use `lightspeedPaymentId` to identify a payment and `accountFiscId` to attribute it to a POS account.
    - `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.

## Changes

> 31 revisions in range; 1 not diffed.

- **2026-02-12** `33472358c1ed`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/changes/f/v2/business-location/:businessLocationId/lightspeed-payments/get.md)

---

[API](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api.md) - [All operations](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/revisions/af001485cf2b?raw)