Back to My Kounta

Gift Card and Payments API

Josh -

Overview

While Kounta provides the capability for you to easily find, create and update customers for your integrated merchant, there are times where Kounta 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 and Checkout 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 (details in API docs).

 

Requests and Response Schemas


Top Up

Allow a user to top-up/activate a gift card or 3rd party profile via the Kounta POS

Request parameters:

  • company_id
  • site_id
  • order_id
  • keyword (from the input)
  • topup_amount
  • reference_id (from the customer if a check-in is selected)

 

Response to us

{
 success: boolean (true or false),
 message: "message we show as confirmation"
}

Kounta 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

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

 

Request parameters:

  • company_id
  • site_id
  • order_id
  • keyword (from the input)
  • reference_id (from the customer if a check-in is selected)

 

Response to us

{
 success: boolean (true or false),
 amount: float, 
 message: "for success is false, or an optional message that can be shown underneath the amount for true"
}

 


Checkout

Allow a user to checkout and partial checkout with a gift card or 3rd party profile

Request parameters:

  • company_id
  • site_id
  • order_id
  • amount
  • keyword (from the input)
  • reference_id (from the customer if a check-in is selected)

 

Response to us

{
 success: boolean (true or false), 
 paid_amount: float,
 tip_amount: float,
          "ref": "INV2-8M9F-B8UN-YQ5S-2G7K"
 message: "for success is false, or an optional message that can be shown underneath the amount for true"
}

 

Have more questions? Submit a request

Comments

Powered by Zendesk