Integrated Bar-tabs

You are ready to start developing your Integrated Bar-tab feature now that you have successfully setup your POS to initiate and process requests through iClient in the test environment. Before you begin, please have a look at the certification criteria, which provide a checklist of the minimum requirements for the certification of Integrated Bar-tab with Tyro.

Certification Criteria Document

Overview

The Integrated Bar-Tabs feature allows you to pre-authorise funds and keep tabs using your POS and EFTPOS without having to keep a customer’s credit card and ID document/s behind the bar. The feature allows customers to request bar-tabs with a set maximum amount, the staff opens a bartab on the POS with the chosen maximum amount, the bar-tab request is then initiated using the initiateOpenTab() function, and the cardholder secures the tab by tapping swiping or inserting their card on the Tyro terminal.

The POS is provided the response to the bar-tab request by iClient via the tranasctionCompleteCallback, with the the tab completion reference contained in the tabCompletionReference response field, the POS can then mark the tab off as secured, and the POS users can keep adding items/orders to the tab within the Bar-tab limit, the bar-tab can be closed off at any time for the amount used up using the closeTab() function with the completion reference included in the request. The bar-tab can also be voided if required, using the voidTab() function.

The main benefits of the Integrated Bar-tab feature are that there is no longer a need for patrons to leave their cards and ID documents behind the bar where they are open to theft or loss or skimming, not to mention that it is not a great user experience, the cardholder consequently does not have to wait until the end of the event to get their card back. There is no risk for the cardholder having the amount exceed their desired tab limit and no risk of the merchant not being settled the funds approved at the end of the event.

Open Tab Request

Making the request | Open tab request

• The POS sets the parameters that comprise the requestParams object as per the requirements of the specific transaction request, these parameters include the following:
  • amount - the amount is mandatory and the POS must declare it, please make sure that the amount is in cents and that the data type is String.
  • The integratedReceipt boolean to indicate whether the POS or the Tyro terminal is responsible for printing the receipts returned during the course of the transactions.Please note that the receipt data will not be returned to the POS if this is set to ‘false'.
• The POS calls the initiateOpenTab(requestParams, transactionCallbacks) function with the requestParams included.
• The POS must also reference the callback functions in the function invocation, the callback functions are responsible for handling the response, and are covered in more detail in the Response Handling section.

Request Example

Given below is an example request for a $100.0 integrated bar-tab request where the POS is printing the integrated receipts i.e. the receipts are being printed through the POS.

var amount = '10000';

function doBarTab(amount) {
    iclient.initiateOpentab({
        amount: amount,
        integratedReceipt: true
    }, {
        receiptCallback: receiptCallbackImpl,
        transactionCompleteCallback: transactionCompleteCallbackImpl
    });

}

Close Tab Request

Making the request | Close tab request

• The POS sets the parameters that comprise the requestParams object as per the requirements of the specific transaction request, these parameters include the following:
  • amount - the amount is mandatory and the POS must declare it, please make sure that the amount is in cents and that the data type is String.
  • The TabCompletionReference boolean used from the Open Tab request which can be used to Close and Void a previously Opened Bar Tab
• The POS calls the doCloseBarTab(amount, completionRefrence) function with the requestParams included.
• The POS must also reference the callback functions in the function invocation, the callback functions are responsible for handling the response, and are covered in more detail in the Response Handling section.

Request Example

Given below is an example request for a $100.0 integrated bar-tab request where the POS is printing the integrated receipts i.e. the receipts are being printed through the POS.

var amount = '10000';
var completionReference = '12001';

function doCloseBarTab(amount,completionReference) {
    iclient.closeTab(amount,completionReference, responseReceivedCallbackImpl);
}

Void Tab Request

Making the request | Void tab request

• The POS sets the parameters that comprise the requestParams object as per the requirements of the specific transaction request, these parameters include the following:
  • The TabCompletionReference boolean used from the Open Tab request which can be used to Close and Void a previously Opened Bar Tab.
• The POS calls the doVoidBarTab(completionRefrence) function with the requestParams included.
• The POS must also reference the callback functions in the function invocation, the callback functions are responsible for handling the response, and are covered in more detail in the Response Handling section.

Request Example

Given below is an example request for a $ 100.0 integrated bar-tab request where the POS is printing the integrated receipts i.e. the receipts are being printed through the POS.

var completionReference = '12001';

function doVoidBarTab(completionReference) {
    iclient.voidTab(completionReference, responseReceivedCallbackImpl);
}

Demo

Demo - JS Fiddle

Please refer to the Transaction Callbacks section for handling the response.