Lightspeed Restaurant K Series API
1.0.0

Lightspeed Restaurant offers a REST API in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

These services are in continuous development and subject to change. Find our versioning policy here.

This is the documentation for version 1.0.0 of the API. Last update on May 1, 2024.

Base URL 
https://api.trial.lsk.lightspeed.app

Get Payment Methods

GET /f/finance/{businessLocationId}/paymentMethods
OAuth2

Returns all payment methods for a business location.

Path parameters

Responses

  • • 200 application/json

    Payment methods returned

    Hide response attributes Show response attributes object
    • _embedded object
      Hide _embedded attribute Show _embedded attribute
      • paymentMethodList array[object]
        Hide paymentMethodList attributes Show paymentMethodList attributes object
        • name string

          Name of the payment type

        • code string

          System code for the payment type

        • accountingReference string

          Accounting reference code, if assigned

        • pmId number

          System identification number for payment type

    • _links object
      Hide _links attribute Show _links attribute
      • self object
        Hide self attribute Show self attribute
GET /f/finance/{businessLocationId}/paymentMethods 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/f/finance/45454565682155/paymentMethods \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "_embedded": {
    "paymentMethodList": [
      {
        "name": "Cash",
        "code": "CASH",
        "accountingReference": "cash-payment",
        "pmId": 1234567890
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https:///api.ikentoo.com/finance/1234567/paymentMethodss"
    }
  }
}