Skip to main content

Zonal: Setting up Bill Payments

Updated

This article lays out the steps you need to follow to set-up Bill Payments on Zonal POS.

 

Table Service API Overview

The iOrder table service API allows LOKE to interact directly with open accounts at the site. This can include:

  • Opening accounts

  • Recalling account details

  • Adding products

  • Adding discounts

  • Making part or full payments

 

The iOrder Table Service API is build upon the iOrder Platform API, so the client needs to have a fully configured and working iOrder estate to use this API.

 

Minimum Requirements for Table Service API

  • Aztec 3.18.0.20072 and later releases

  • Zonal Connect Framework Head Office v4.30.0 (or greater)

  • Zonal Connect Framework Site Service v4.30.0 (or greater)

  • Fully configured iOrder estate

 

Configuring Aztec for Table Service API

This is a summary of the additional steps for setting up the Table Service API:

 

First time setup

Additional sites

New integrators

Create two addition user(s) with Front of House (FoH) access

Yes

 

 

Create one or more suitable payment methods

Yes

 

Yes

Send To PoS

Yes

Yes

Yes

 

Create two Front of House (FOH) user for iOrder

An unattended user is required for iOrder to interact with accounts. Two users should be created

 

This user NEEDS to be different to the user setup in ‘remote mobile ordering’ tills in Base Data → Estate Structure → Sales Area Settings → Mobile Ordering a PoS user.
If the same user is used, then the Table Service API will return errors.

 

Location of configuration
Aztec Start Page > Staff & Security > Users

 

Creating a FOH user

  1. Select Add to create a new ‘Front of House’ user

  2. Complete the Enter User Details form (click Next when complete)

  3. Select relevant roles on Select Front of House Role Membership form (click Next when complete)

Field Name

Suggested Value

Notes

First name:

Table

These values are examples only. The name of the user can be determined by the person configuring the system.

Last name:

Service

 

User position:

RemoteAccess

It is recommended that a dedicated user position be created for remote ZCF access. The given value is a suggestion only.

Role type:

{Specific to configuration}

The role type will depend on the configuration of Aztec.

 

  1. If multiple roles are selected, you will be required to select ‘Default terminal role’ on this form. If not proceed to step 5

  2. Complete Front of House Login form (click Finish to complete setup)

  3. Capture the ID of the Table Service user
    This is acquired by executing an SQL query on the ‘ac_users’ table in the Aztec database, to find the ID of the POS user setup.

 

Create a Payment Method

When an integrator records a payment they need to use a defined payment ID. The payment type can be used as the primary way of reconciling payments from different sources. It is therefore recommended that each integrator has its own payment type in Aztec.

 

Location of configuration
Aztec Start Page > Finance > Configuration > Payment Methods

 

Creating a payment method

  1. Select Add to create a new payment method

 

  1. Complete the Enter Payment Method Details form

Field Name

Suggested Value

Notes

Payment method name:

Use an integrator specific name

These values are examples only. This value can be determined by the person configuring the system.

Type:

Central

Cash type can be used but it is not recommended


POS button text:

Use an integrator specific name

The button text is generated from the payment method name, you can override this behaviour by selecting ‘Manually’ from the ‘Generate button text’ radio buttons and adding the required text.

Open cash drawer:

Not selected

Remote access payment methods must not open the cash drawer.

Overpayment is:

Tip & Ensure ‘Prompt when no overpayment’ is selected

“Change” is not recommended

  1. Save your changes and exit Aztec Finance

  2. Capture the ID of Payment Methods setup.
     This is acquired by executing an SQL query on the ‘ac_PaymentMethod’ table in the                     Aztec database.

 

Raise iOrder Service Request

A service request needs to be raised to add the additional settings to the iOrder database

 

  • Add the employees IDs to iOrder database for the clients estate (with employee IDs)

  • Add “pay at table” to the Ordering modes for the clients estate

 

A separate service request needs to be raised to give the integrator API user the correct permissions. You will need to provide the API user name, which can be find in iOrder.

Permissions:  Add private_api_methods to "placePaidOrder,getZCFDetails"​​​​​​​

Once both service requests have been completed, the integrator can start their testing.

Related articles