Protocol
| Header | Length | Data | ||||||
|---|---|---|---|---|---|---|---|---|
0x13 | 0x05 | 1 Byte : Protocol Version
Version 3 is recommended. | ||||||
| 4 Bytes : Protocol Options Bitwise field, see details below |
Usage
- This command is optionally used to establish the Protocol Version and Options
Protocol Version
Version 3 is the default and is recommended. Versions 1 and 2 were provided for legacy suppport for P6X terminals running older software. This software is no longer supported itself, so Version 3 should be used at all times.
Protocol Options
The following options are defined. It is bitwise, meaning the selected values are added together to equal the required total.
0x01: Enable Transaction State Event0x02: Enable Authorization DOL0x04: Enable Extended Block format (Apollo only)0x08: Enable Detailed Result Codes and Declined reasons (Apollo only)0x10: Enable Declined DOL (Apollo only)- Other : Reserved
Protocol Option Detailed Explanation & Usage
| Protocol Option Name | Explanation & Usage |
|---|---|
| Transaction State Event | PSP will send the current Transaction State Event command during the payment flow. This can then be used to update the integration controller's state, for example to provide a UI message or disable another payment option. |
| Authorization DOL | Enabling this will add all "Authorization" DOLs to the list of expected DOLs. The DOL List shows these where "Auth" appears in the Stage/Scenario column in that table. |
| The following three Protocol Options are APOLLO Only functionality | |
| Extended Block Format Apollo Only | If extended block format is enabled, all new requests and responses must be in the new extended block format. The protocol response will however be in the default block format, even when Extended Block Format is conformed in this response. On protocol reset the default block format will be used. |
| Detailed Result and Decline Codes Apollo Only | Additional context is provided in the Result & Session Declined Responses. See each response for more information. |
| Enabled Declined DOL Apollo Only | Enabling this will add all "Decline" DOLs to the list of expected DOLs. The DOL List shows these where "Decline" appears in the Stage/Scenario column in that table. |
Options Examples
Whilst the Options component of the Protocol command has a 4 byte length, with the current limitation of 5 different commands, the maximum value of the options component is 0x1F. This would be formatted as 0x0000001F in the command.
Enabling only Extended Block Format and Detailed Result Codes would require the options block to be 0x0000000C i.e. 0x04 + 0x08.
Response
Protocol command
The response will only include the validated requests e.g. 0x07 sent in for a P6X terminal will only return 0x03 as Extended Block Format 0x04 is not supported on the P6X terminal.