Sample Workflows

Introduction

This article presents and overview of potential workflows for a gift card integration.

Before You Begin

Make sure you have set up an item and payment method in the K-Series Back Office, and configured your web extension

Workflows

Redeem/Pay with Gift Card

1. Initiating Redemption

• Using the web extension, an employee scans the gift card for redemption. Your application uses the data sent to the configured callback to check the balance of the gift card.
  • Web Extension Functions: pos_onBarcodeScanEvent(callback) or pos_onNFCEvent(callback)

2. Determine Payment Amount

• Before adding the payment, retrieve the order total. This ensures the correct total amount (inclusive of tax) is added, especially for full payments.

• Web Extension Function: pos_getCurrentAccount()

Note

• The total amount returned by pos_getCurrentAccount() includes tax, for both tax-exclusive and tax-inclusive scenarios.
• Individual item and unit tax amounts for tax-exclusive scenarios cannot be determined with this function. To calculate the tax amount for individual items, use the tax-breakdown endpoint.

3. Add Payment

• The employee inputs the Gift Card payment amount the customer wishes to redeem. Add payment to the current receipt using the specific gift card payment method code or return an error for insufficient balance.
  • Web Extension Functions: pos_addPayment(amountCents, paymentMethodCode, callback)

4. Checkout

• Once payment has been applied, return the employee to the checkout screen to complete the sale.
  • Web Extension Function: pos_navigateToCheckoutView()

5. Real-Time Notifications

• Listen to real-time notification webhooks for finalized receipt details.
  • See RTN Examples

Check Gift Card Balance

1. Balance Check

• In the web extension, an employee scans or manually enters the gift card number to check the balance. Your application uses the data sent to the configured callback to check for an existing gift card and the balance, if applicable.
  • Web Extension Functions: pos_onBarcodeScanEvent(callback) or pos_onNFCEvent(callback)

2. Display Balance

• Display the balance in the POS.
  • Web Extension Functions: pos_postMessage(data)