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

Notifications payment

POST /Payment notification

What your webhook implementation will receive when placing a payment

application/json

Body Required

  • reason string

    Reason for failure if there is one

  • thirdPartyReference string

    Third-party reference you provided when the order or payment was placed.

  • businessLocationId integer(int64)

    The unique identifier of the business location.

  • ikentooAccountIdentifier string

    The K-series account identifier for a SUCCESS event (V3 format)

  • iKentooAccountId integer(int64) Deprecated

    The K-series account identifier for a SUCCESS event (V2 format)

  • status string

    Status of the order or payment operation.

    Values are SUCCESS or FAILURE.

  • type string

    Notification type

    Default value is PAYMENT.

Responses

  • • 200

    Your server returns this code if it accepts the callback

POST Payment notification
Request examples 
{
  "thirdPartyReference": "REF11",
  "businessLocationId": 247158188015618,
  "status": "SUCCESS",
  "ikentooAccountId": "2114502594134196",
  "ikentooAccountIdentifier": "A123080.14",
  "type": "PAYMENT"
}
{
  "reason": "the payment amount is greater than the amount due",
  "thirdPartyReference": "REF12212",
  "businessLocationId": 141948669832802,
  "status": "FAILURE",
  "ikentooAccountIdentifier": "A78094.73",
  "type": "PAYMENT"
}