Gift Cards & Payments

While Kounta by Lightspeed provides the capability for you to easily find, create and update customers for your integrated merchant, there are times where Kounta by Lightspeed may not yet know about these customers or you may not be required/allowed to share this data with the merchants, or simply want a faster way to process specific actions such as check out.

As such we've provided the ability to Top-Up, Check Balance, Checkout and Refund without explicitly identifying the customer first. We enable these actions through the POS, when called we prompt the user for some identifying information through a range of inputs including:

  • - Manual text entry of say a name, phone number or member ID
  • - Trigger a card swipe on Blackline enabled payments systems for card swipes etc.
  • - Surface the customers that are checked-in and linked to your Add-On enabling simple check-in payments
  • - Barcode scanning for supported scanners (if you're already using it to search for products etc)

In future we will extend this to include additional inputs such as camera access, QR scanning and NFC depending on the peripherals and device of the merchant.

Enabling the Gift Card and Payments API

To enable this functionality, log in to your account and access the Add-On settings via your Add-On tile.

  • - All configuration is done in back-office via your add-on.
  • - Requests will be a POST to the URLs you configure, with the parameters shown below.
  • - We will also include an X-Kounta-Signature header that you can use to verify the request is from Kounta by Lightspeed.

Top-Up

Allows a user to top-up/activate a gift card or 3rd party profile via the Kounta by Lightspeed POS.

The request body will include company_id, site_id, register_id, order_id, keyword, topup_amount, and reference_id if from a customer check-in.

Your response should be a 200 OK in the format:

Kounta by Lightspeed will handle the collection of payment and the subsequent accounting attached to this. You simply need to confirm the top up amount, hold the balance and reduce the balance upon a successful checkout action.

Balance Check

Allows a user to check the balance of a gift card or 3rd party profile.

The request body will include company_id, site_id, register_id, order_id, keyword, and reference_id if from a customer check-in.

Your response should be a 200 OK in the format:

Checkout

Allows a user to perform a checkout, and partial checkout, with a gift card or 3rd party payment profile.

The request body will include company_id, site_id, register_id, order_id, keyword, amount, and reference_id if from a customer check-in.

Your response should be a 200 OK in the format:

All fields are required.

You can return a paid_amount less than the amount requested if you wish to allow for partial payments.

Refund

Allows a user to perform a refund to your payment type.

The request body will include company_id, site_id, register_id, order_id, refund_amount.

Your response should be a 200 OK in the format:

All fields are required.