View Source

Versions

Maximal protocol version supported should be set in each command and answer.

Version 2 optional tag Tip has been added to AuthPayResponse, ConfPay. It cаn be added only if version 2 has version attribute in AuthPay

r_keeper 7 Settings

For tips fill parameter TipChargeForAuthTerminal "Tip for authorization terminal"

AUHTTP Driver Description

Each auth proc will make an HTTP request to the address like https://127.0.0.1:1212/authtest/authpay.xml, https://127.0.0.1:1212/authtest/confpay.xml, etc.
You should make this request specifying the neccesary parameters. Find more details in the examles below,

AUHTTP Driver Configuration

r_keeper 7 > AUTHTTP > image2022-6-28_16-58-3.png

r_keeper 7 > AUTHTTP > image2022-6-28_16-56-44.png

XML Data Format Description

AuthPay/ConfPay/VoidPay: request

<?xml version="1.0" encoding="utf-8"?>
<ConfPay version="1">
    <SrcID cashguid="{A776FBF7-F9B3-4E14-946E-AB717BA4884B}" servguid="{C31D76A2-09EC-419F-9EA8-7AB85D7446F8}" restguid="{FC1BBB36-4D7F-4EF9-80C2-33B78ADBDB6A}" fullcode="016470001"/>
    <Order/>
    <MyPay myAmount="288000"/>
    <auXML>
        <ActionID>1</ActionID>
        <CardCode>SomeText</CardCode>
        <AuthCode>AuthCode</AuthCode>
        <AuthInfo>AuthInfo</AuthInfo>
    </auXML>
  <!-- Optional Tip in ConfPay and VoidPay from version 2, only if Tip was returned in AuthPayResponse-->
  <Tip>
    <MyPay myAmount="10000"/>
    <auXML>
        <ActionID>56014</ActionID>
        <AuthCode>AuthCode</AuthCode>
        <AuthInfo>AuthInfo</AuthInfo>
        <CardCode>5536 91.. .... ....</CardCode>
    </auXML>
  </Tip>
</ConfPay>

SrcID: source information — Restaurant/Server/Cash station, etc.
Order: order content — empty in this example
MyPay: amount information — currency will be added later
auXML: previous calls payment info — to find transaction data to void/confirm the payment

AuthPay/ConfPay/VoidPay: response

<?xml version="1.0" encoding="utf-8"?>
<!-- AuthPayResponse, ConfPayResponse, VoidPayResponse according to request main tag-->
<ConfPayResponse version="1">
  <OpResult>1</OpResult>
  <ActionID>56014</ActionID>
  <CardCode>SomeText</CardCode>
  <AuthCode>AuthCode</AuthCode>
  <AuthInfo>AuthInfo</AuthInfo>
  <PrinterT>
        <Unfiscal CutAfter="1">
            <TextLine Text="--------------------------------" />
            <TextLine Text="    MOKĖJIMO KORTELĖS KVITAS" />
            <TextLine Text="TERMINALO NR.:          TMM01651" />
            <TextLine Text="PREKYBININKO NR.:        0001651" />
            <TextLine Text="MAESTRO  (C)" />
            <TextLine Text="" />
            <TextLine Text="676515******0400" />
            <TextLine Text="BYLA: 000007    KVITO NR: 122381" />
            <TextLine Text="DATA: 2015.08.18   LAIKAS: 12:08" />
            <TextLine Text="RRN: 523012077523 AUT.K.: 851840" />
            <TextLine Text="AID: A0000000043060 APP: MAESTRO" />
            <TextLine Text="TC:  BD67A2DC2F76C234" />
            <TextLine Text="TVR: 0800008000      TSI:   E800" />
            <TextLine Text="           PARDAVIMAS" />
            <TextLine Text="" />
            <TextLine Text="SUMA:                   1.16 EUR" />
            <TextLine Text="" />
            <TextLine Text="  PIN KODAS ĮVESTAS TEISINGAI" />
            <TextLine Text="" />
            <TextLine Text="          PATVIRTINTA" />
            <TextLine Text="" />
            <TextLine Text="IŠSAUGOKITE ČEKĮ, KAD GALĖTUMĖTE" />
            <TextLine Text="" />
            <TextLine Text="  PATIKRINTI SĄSKAITOS IŠRAŠĄ" />
            <TextLine Text="--------------------------------" />
            <TextLine Text="" />
        </Unfiscal>
    </PrinterT>
  <DisplayT>Show me on Display</DisplayT>
  <ConfPrnT>0</ConfPrnT>
  <!-- Tip from version 2, only if 2+ in ConfPay/@version -->
  <Tip>
    <ActionID>56014</ActionID>
    <AuthCode>AuthCode</AuthCode>
    <CardCode>5536 91.. .... ....</CardCode>
    <AuthInfo>AuthInfo</AuthInfo>
    <MyPay myAmount="10000"/>
  </Tip>
</ConfPayResponse>

Root node has one of the following values: AuthPayResponse/ConfPayResponse/VoidPayResponse.
OpResult: operation result — 1 if okay, 0 if fail. 1 is the default value
ActionID, CardCode, AuthCode, AuthInfo: payment data — will be available in subsequent calls to confpay.xml/authpay.xml in auXML block, also will be stored in r_keeper database and available in reports
PrinterT: text to be printed
DisplayT: message to be displayed
ConfPrnT: confirmation flag — the message box before receipt printing is required

GetMenuList: request

<?xml version="1.0" encoding="utf-8"?>
<GetMenuList version="2"/>

GetMenuList: response

<?xml version="1.0" encoding="utf-8"?>

<GetMenuListResponse version="2">
  <MENU>
    <MENUITEM caption="Menu 1" operationId="{607D07C9-42E9-4F92-B8AD-7AE051D4AB15}" parameter="12345" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}" userRight="{E3F2D792-1AC5-46D0-B53F-250FD8C3C189}"/>
    <MENUITEM caption="Menu 2 - with submenu">
      <MENUITEM caption="Menu 2: SubMenu 1" operationId="{B012B4DD-3ED9-422C-A28E-D0BF0152F931}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
      <MENUITEM caption="Menu 2: SubMenu 2">
        <MENUITEM caption="Menu 2: SubMenu 2: SubSubMenu 1" operationId="{59D8C6CA-809D-45B6-9D4E-0D7CCC21569A}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
        <MENUITEM caption="Menu 2: SubMenu 2: SubSubMenu 2" operationId="{56A61F0A-13A9-4FD2-A328-D41893576A3A}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
        <MENUITEM caption="Menu 2: SubMenu 2: SubSubMenu 3" operationId="{2D551616-229A-4EAA-A333-8F06D926F70D}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
      </MENUITEM>
      <MENUITEM caption="Menu 2: SubMenu 3">
        <MENUITEM caption="Menu 2: SubMenu 3: SubSubMenu 1">
          <MENUITEM caption="Menu 2: SubMenu 3: SubSubMenu 1: SubSubSubMenu: 1" operationId="{0E2F7D7F-8AE1-4F55-937A-4445C30AB1D0}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
          <MENUITEM caption="Menu 2: SubMenu 3: SubSubMenu 1: SubSubSubMenu: 2" operationId="{B7C5A6D9-5E43-4159-9C8D-ADBF1B26EC18}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
        </MENUITEM>
      </MENUITEM>
    </MENUITEM>
    <MENUITEM caption="Menu 3 - with dialogs">
      <MENUITEM caption="Menu 3: SubMenu 1 with  dialog DateInterval" operationId="{47704B77-5D7A-4B66-9250-DC37238095B1}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}">
        <DIALOGINFO dialogType="DateInterval" caption="Enter date interval"/>
      </MENUITEM>
      <MENUITEM caption="Menu 3: SubMenu 2 with  dialog NumberInterval" operationId="{51EC80F4-3612-4828-9330-6BDD814D7678}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}">
        <DIALOGINFO dialogType="NumberInterval" caption="Enter number interval"/>
      </MENUITEM>
      <MENUITEM caption="Menu 3: SubMenu 3 with  dialog OneDate" operationId="{773B5388-9C30-4878-B338-6D37EEAC8576}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}">
        <DIALOGINFO dialogType="OneDate" caption="Enter date"/>
      </MENUITEM>
      <MENUITEM caption="Menu 3: SubMenu 4 with  dialog OneNumber" operationId="{29A0D2FC-19CB-40F2-B2ED-02699D7CEB5F}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}">
        <DIALOGINFO dialogType="OneNumber" caption="Enter number"/>
      </MENUITEM>
    </MENUITEM>
  </MENU>
</GetMenuListResponse>

ExecMenuItem: request

<?xml version="1.0" encoding="utf-8"?>
<ExecMenuItem version="2">
    <OperationId>{607D07C9-42E9-4F92-B8AD-7AE051D4AB15}</OperationId>
    <Parameter>12345</Parameter>
</ExecMenuItem>

ExecMenuItem: response

<?xml version="1.0" encoding="utf-8"?>
<ExecMenuItemResponse version="2">
  <OpResult>1</OpResult>
  <PrinterT>
        <Unfiscal CutAfter="1">
            <TextLine Text="----Unfiscal doc 1 header-------"/>
            <TextLine Text="Some unfiscal 1 text line 1     "/>
            <TextLine Text="Some unfiscal 1 text line 2     "/>
            <TextLine Text=""/>
        </Unfiscal>
        <Unfiscal CutAfter="1">
            <TextLine Text="----Unfiscal doc 2 header-------"/>
            <TextLine Text="Some unfiscal 2 text line 1     "/>
            <TextLine Text="Some unfiscal 2 text line 2     "/>
            <TextLine Text="Some unfiscal 2 text line 3     "/>
            <TextLine Text="Some unfiscal 2 text line 4     "/>
            <TextLine Text="Some unfiscal 2 text line 5     "/>
            <TextLine Text=""/>
        </Unfiscal>
  </PrinterT>
  <DisplayT>Show me on Display</DisplayT>
</ExecMenuItemResponse>

Interaction Scenario Example

1. authpay.xml: authorizations request

The server must use the MyPay node from the AuthPay document to determine the required amount
In case of successful execution the server should set OpResult to 1 (version 4+) and fill the CardCode, AuthCode, AuthInfo, ActionID parameters.
The server may set the ConfPrnT parameter if the receipt printing confirmation message is required on cash stations
The server may set the PrinterT parameter if an additional printed text is required
If the server is unable to execute a required operation it must set OpResult to 0 and fill the DisplayT parameter or return an HTTP error code with the description

2. confpay.xml: confirmation request

The server must use the MyPay node from the AuthPay document to determine the required amount
The server may use the auXML node data to identify the transaction. This block will contain values received in authorizations call
In case of successful execution server should set OpResult to 1 (version 4+) and fill the CardCode, AuthCode, AuthInfo, ActionID parameters if any of them were changed since authorization
The server may use the auXML node data to identify transaction. This block will contain values received in authorizations call
The server may set the ConfPrnT parameter if the receipt printing confirmation message is required on cash stations
The server may set the PrinterT parameter if an additional printed text is required
If the server is unable to execute a required operation it must set OpResult to 0 and fill the DisplayT parameter or return an HTTP error code with the description

3. voidpay.xml: void request

The server must use the auXML node data to identify transaction. This block will contain values received in authorizations call
The server must use the MyPay node from the AuthPay document to determine the required amount
In case of successful execution the server should set OpResult to 1 (version 4+) and fill the CardCode, AuthCode, AuthInfo, ActionID parameters if any of them were changed since authorization
The server may set the PrinterT parameter if additional printed text is required
If the server is unable to execute a required operation it must set the OpResult to 0 and fill the DisplayT parameter or return an HTTP error code with the description

4. doshift.xml: shifts totals request

When a common shift is closed, the driver will call doshift.xml with following data:

<?xml version="1.0" encoding="utf-8"?>
<DoShift version="1">
    <SrcID cashguid="{4E4C529F-88EF-4BFF-A8C4-9C3D9524BC42}" servguid="{F64F66DA-5463-46A0-BDCD-97DE92026F0E}" restguid="{FC1BBB36-4D7F-4EF9-80C2-33B78ADBDB6A}" fullcode="199990053"/>
</DoShift>

The server must answer with DoShiftResponse (no action at this moment):

<?xml version="1.0"?>
<DoShiftResponse version="1"/>
  <PrinterT>
        <Unfiscal CutAfter="1">
            <TextLine Text="   START CARD TERMINAL REPORT   "/>
            <TextLine Text="             ...                "/>
            <TextLine Text="   REPORT IN PROGRESS           "/>
            <TextLine Text="             ...                "/>
            <TextLine Text="  FINISH CARD TERMINAL REPORT   "/>
        </Unfiscal>
    </PrinterT>

5. getmenulist.xml: menu structure request:

Post request to: http://127.0.0.1:1220/authcall.xml/getmenulist.xml

<?xml version="1.0" encoding="utf-8"?>
<GetMenuList version="2"/>

Response expample:

<?xml version="1.0" encoding="utf-8"?>
<GetMenuListResponse version="2">
  <MENU>
    <MENUITEM caption="Menu 1" operationId="{607D07C9-42E9-4F92-B8AD-7AE051D4AB15}" parameter="12345" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}" userRight="{E3F2D792-1AC5-46D0-B53F-250FD8C3C189}"/>
    <MENUITEM caption="Menu 2 - with submenu">
      <MENUITEM caption="Menu 2: SubMenu 1" operationId="{B012B4DD-3ED9-422C-A28E-D0BF0152F931}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
      <MENUITEM caption="Menu 2: SubMenu 2">
        <MENUITEM caption="Menu 2: SubMenu 2: SubSubMenu 1" operationId="{59D8C6CA-809D-45B6-9D4E-0D7CCC21569A}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
        <MENUITEM caption="Menu 2: SubMenu 2: SubSubMenu 2" operationId="{56A61F0A-13A9-4FD2-A328-D41893576A3A}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
        <MENUITEM caption="Menu 2: SubMenu 2: SubSubMenu 3" operationId="{2D551616-229A-4EAA-A333-8F06D926F70D}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
      </MENUITEM>
      <MENUITEM caption="Menu 2: SubMenu 3">
        <MENUITEM caption="Menu 2: SubMenu 3: SubSubMenu 1">
          <MENUITEM caption="Menu 2: SubMenu 3: SubSubMenu 1: SubSubSubMenu: 1" operationId="{0E2F7D7F-8AE1-4F55-937A-4445C30AB1D0}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
          <MENUITEM caption="Menu 2: SubMenu 3: SubSubMenu 1: SubSubSubMenu: 2" operationId="{B7C5A6D9-5E43-4159-9C8D-ADBF1B26EC18}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}"/>
        </MENUITEM>
      </MENUITEM>
    </MENUITEM>
    <MENUITEM caption="Menu 3 - with dialogs">
      <MENUITEM caption="Menu 3: SubMenu 1 with  dialog DateInterval" operationId="{47704B77-5D7A-4B66-9250-DC37238095B1}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}">
        <DIALOGINFO dialogType="DateInterval" caption="Enter date interval"/>
      </MENUITEM>
      <MENUITEM caption="Menu 3: SubMenu 2 with  dialog NumberInterval" operationId="{51EC80F4-3612-4828-9330-6BDD814D7678}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}">
        <DIALOGINFO dialogType="NumberInterval" caption="Enter number interval"/>
      </MENUITEM>
      <MENUITEM caption="Menu 3: SubMenu 3 with  dialog OneDate" operationId="{773B5388-9C30-4878-B338-6D37EEAC8576}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}">
        <DIALOGINFO dialogType="OneDate" caption="Enter date"/>
      </MENUITEM>
      <MENUITEM caption="Menu 3: SubMenu 4 with  dialog OneNumber" operationId="{29A0D2FC-19CB-40F2-B2ED-02699D7CEB5F}" purposeToLock="{7DA9C7F9-7DAE-462F-9FC5-113E2E3810B2}">
        <DIALOGINFO dialogType="OneNumber" caption="Enter number"/>
      </MENUITEM>
    </MENUITEM>
  </MENU>
</GetMenuListResponse>

6. execmenuitem.xml: menu item execution request:

Post request to: http://127.0.0.1:1220/authcall.xml/execmenuitem.xml

<?xml version="1.0" encoding="utf-8"?>
<ExecMenuItem version="2">
    <OperationId>{607D07C9-42E9-4F92-B8AD-7AE051D4AB15}</OperationId>
    <Parameter>12345</Parameter>
</ExecMenuItem>

Response example:

<?xml version="1.0" encoding="utf-8"?>
<ExecMenuItemResponse version="2">
  <OpResult>1</OpResult>
  <PrinterT>
        <Unfiscal CutAfter="1">
            <TextLine Text="----Unfiscal doc 1 header-------"/>
            <TextLine Text="Some unfiscal 1 text line 1     "/>
            <TextLine Text="Some unfiscal 1 text line 2     "/>
            <TextLine Text=""/>
        </Unfiscal>
        <Unfiscal CutAfter="1">
            <TextLine Text="----Unfiscal doc 2 header-------"/>
            <TextLine Text="Some unfiscal 2 text line 1     "/>
            <TextLine Text="Some unfiscal 2 text line 2     "/>
            <TextLine Text="Some unfiscal 2 text line 3     "/>
            <TextLine Text="Some unfiscal 2 text line 4     "/>
            <TextLine Text="Some unfiscal 2 text line 5     "/>
            <TextLine Text=""/>
        </Unfiscal>
  </PrinterT>
  <DisplayT>Show me on Display</DisplayT>
</ExecMenuItemResponse>

If the server is unable to execute a required operation, it must return an HTTP error code with the description

Solved Issues

1. There is not enough info to VOID transaction at this moment

We have added the auXML section with the CardCode, AuthCode, AuthInfo, ActionID data: this will allow you to find previous transaction info.

2. An ability to print and show the mesage on the screen after an authorization process and in case of any stage operation error

We have added the OpResult to determine operation result and the PrinterT/DisplayT nodes:

If OpResult is 0 and DisplayT contains some text, the message will be shown on the station
If PrinterT contains some text, it will be printed on a printing device

3. An ability to enable document printing confirmation window

We have added the ConfPrnT parameter:

0 — the default value
1 — if you need receipt printing confirmation