# 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.


## Servers
- Demo URL: https://api.trial.lsk.lightspeed.app (Demo URL)
- Production URL: https://api.lsk.lightspeed.app (Production URL)


## Authentication methods
- O auth2


## Parameters

### Path parameters
- **businessLocationId** (integer(int64))
  The unique identifier for the business location.

### Query parameters
- **from** (string(date-time))
  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.
- **offset** (integer(int32))
  The pagination offset.
- **sortDirection** (string)
  The direction to sort the results.
- **dateType** (string)
  The date used when querying and sorting results.
- **status** (array[string])
  Payment statuses to filter the result set by.


## Responses
### 200
successful operation

#### Body: application/json (object)
- **payments** (array[object])
  List of requested payments.
- **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
Bad Request - Invalid request parameters or format.

#### Body: application/json (object)
- **error** (string)



[Powered by Bump.sh](https://bump.sh)