Lightspeed Payments Data

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://api-docs.lsk.lightspeed.app/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Lightspeed Restaurant K-Series MCP server": {
    "url": "https://api-docs.lsk.lightspeed.app/mcp"
  }
}

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

O auth2

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.

Path parameters

businessLocationId integer(int64) Required

The unique identifier for the business location.

Minimum value is 1.

Query parameters

from string(date-time) Required

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.
to string(date-time)

End of requested results, in ISO 8601 format.

Results queried by the dateType parameter.
pageSize integer(int32)

Number of entries to return.

Maximum value is 100. Default value is 50.
offset integer(int32)

The pagination offset.

Default value is 0.
sortDirection string

The direction to sort the results.

Values are ASC or DESC. Default value is ASC.
dateType string

The date used when querying and sorting results.

Values are CREATED or MODIFIED. Default value is MODIFIED.
status array[string]

Payment statuses to filter the result set by.

Values are CAPTURED, DISPUTED, PARTIALLY_REFUNDED, or REFUNDED.

Responses

200 application/json

successful operation
Hide response attributes Show response attributes object
- payments array[object]
  
  List of requested payments.
  
  Hide payments attributes Show payments attributes object
  
  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 string
  
  The statuses for a Lightspeed Payments transaction.
  
  Values are CAPTURED, DISPUTED, PARTIALLY_REFUNDED, or REFUNDED.
  
  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 object
  
  Hide fees attributes Show fees attributes object
  
  value string
  
  The amount in dollars.
  
  currency string
  
  The currency code.
  
  surcharge object
  
  Hide surcharge attributes Show surcharge attributes object
  
  value string
  
  The amount in dollars.
  
  currency string
  
  The currency code.
- pageSize integer(int32)
  
  Size of the returned collection.
- offset integer(int32)
  
  Offset of the first item returned in the collection.
- nextOffset integer(int32)
  
  Next offset to get next page of data based off current pageSize and offset, if available.
400 application/json

Bad Request - Invalid request parameters or format.
Hide response attribute Show response attribute object
- error string Required

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

curl \
 --request GET 'https://api.trial.lsk.lightspeed.app/f/v2/business-location/45454565682155/lightspeed-payments?from=2023-01-01T14%3A00%3A00Z' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "payments": [
    {
      "accountFiscId": "A72691.8",
      "lightspeedPaymentId": "ad-GJ33PFSCGVG4NFH4",
      "uuid": "bc7i2X_CTkeg8qlec66wmg==",
      "reference": "RFOOVMIMPSDY",
      "status": "CAPTURED",
      "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,
  "offset": 0,
  "nextOffset": 100
}

Response examples (400)

{
  "error": "Invalid date format: 12/12/2023"
}

{
  "error": "'from' date cannot be after 'to' date"
}