FinancialV2

Lightspeed Payments Data

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) payments completed through Adyen terminals and prepaid Order Anywhere transactions may be omitted when no payment reference or POS metadata is generated. We are aware of this limitation 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 for more details.

get/f/v2/business-location/{businessLocationId}/lightspeed-payments

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

Query parameters

fromstring date-time required

Example:2023-01-01T14:00:00Z

Start of requested results, in ISO 8601 format.

The date range between 'from' and 'to' cannot exceed 365 days (1 year).

Results queried by the dateType parameter.

tostring date-time

Example:2023-01-01T13:00:00Z

End of requested results, in ISO 8601 format.

Results queried by the dateType parameter.

pageSizeinteger

Number of entries to return.

offsetinteger

The pagination offset.

sortDirection'ASC' | 'DESC'

The direction to sort the results.

Example:ASC

dateType'CREATED' | 'MODIFIED'

The date used when querying and sorting results.

Example:CREATED

statusFinancialApiLSPaymentStatus[]

Payment statuses to filter the result set by.

Response

successful operation

pageSizeinteger

Size of the returned collection.

offsetinteger

Offset of the first item returned in the collection.

nextOffsetinteger

Next offset to get next page of data based off current pageSize and offset, if available.

Example response

{
  "payments": [
    {
      "accountFiscId": "A72691.8",
      "lightspeedPaymentId": "ad-GJ33PFSCGVG4NFH4",
      "uuid": "bc7i2X_CTkeg8qlec66wmg==",
      "reference": "RFOOVMIMPSDY",
      "createdDate": "2022-09-21T10:11:56Z",
      "captureDate": "2022-09-21T10:11:56Z",
      "modificationDate": "2022-09-21T10:11:56Z",
      "fees": {
        "value": "0.00",
        "currency": "CAD"
      },
      "surcharge": {
        "value": "0.00",
        "currency": "CAD"
      }
    }
  ],
  "pageSize": 100,
  "nextOffset": 100
}