Technical specification

Technical specification for integrating POS software with the REGOS: VCR virtual cash register.

General information

The following tasks are proposed for a basic integration of your POS software with the REGOS: VCR virtual cash register:

1. Opening / closing a cash register shift;
2. Processing payments through electronic payment systems (ClickPass, PaymeGo, etc.);
3. Registering sales / refunds.

The procedure for communicating with the virtual cash register API is described at this link.

Before communicating with the virtual cash register, check that it is ready for operation by calling Sys.Initialize.

1. Opening / closing a cash register shift

Use ZReport.Open and ZReport.Close to open and close a cash register shift, respectively.

2. Processing payments through electronic payment systems

The virtual cash register workflow requires the user to process a payment through an electronic payment system and then register the sale with that payment. Perform the following steps:

1. Process the payment through the electronic payment system using Payment.Create;
2. If successful, save the payment id in the POS software database;
3. Register the sale, passing the payment_id from the previous step.

3. Registering sales / refunds

To register a sale, call Receipt.Sale.

To register a refund, the following steps are recommended:

1. Scan the link on the sale receipt and call Receipt.CheckQRCodeUrl;
2. If the response is positive, call Receipt.Refund. In the refund_info object, pass the link from the previous step in the QRCodeURL field.