Configurable Options
Parts of PSP behaviour can be configured in the Setup
and Protocol
commands detailed in the next section and in Communication Setup, but more uniform behaviour can also be stored in the terminal itself, and used for every payment. This section details some of these optional configurations.
Advanced vs Basic Configuration
Payter have provided Advanced Configuration guidance below, but most of these settings can be adjusted in MyPayter using Basic Configuration and we recommend this. Basic Configuration uses toggles and drop down lists for values that can be restricted in this way, and displays optional settings dynamically.
Advanced Configuration Options
If using Advanced Configuration, all of the below values must be entered exactly as they appear in the Advanced Configuration section of MyPayter. Please contact us for assistance with configuring any aspect of the below options.
Consider using Basic Configuration where possible to adjust these settings instead.
The syntax for P6X and Apollo terminals varies. Please select your terminal type from the below two tabs.
PSP Settings
- Apollo
- P6X
Setting Name | Tab Name | Data Type | Default Value | Description | |||||
---|---|---|---|---|---|---|---|---|---|
mode | apollo-scap-psp | String | tcp | The method of connection to the terminal. Choices are:
tls is a variant of TCP/IP where Transport Layer Security is required for Controller to Terminal communication. | |||||
tcp-port | apollo-scap-psp | Integer | 3201 | The port used by the TCP/IP connection when it is used. | |||||
baud-rate | apollo-scap-psp | String | 115200 | Baud rate is for Serial communication only, and will depend on the Controller settings. Choices are:
| |||||
card-detect-timeout | apollo-scap-psp | Integer | 60 | How long in seconds a Start Session command will persist for. To turn off the timeout completely, please use 2147483647 . | |||||
payment-type | apollo-scap-psp | String | pre-auth | What type of Payment to use. Choices are:
pre-auth . | |||||
hide-idle-screen | apollo-scap-psp | Boolean | false | Setting to true suppresses the Idle screen, showing a blank screen instead. Payter now instead recommend utilising a custom idle screen here. |
P6X has no configurable user interface, and the configuration relies much more on the Basic options to set things like Baud Rate.
Setting Name | Tab Name | Data Type | Default Value | Description | |||||
---|---|---|---|---|---|---|---|---|---|
MAGIC_BYTE | PTOS_PVP | Integer | 60 | The configurable Magic Byte. Note that 60 resolves to 0x3C in hexadecimal. | |||||
PAYFLOW | PTOS_PVP | Integer | 0 | What type of Payment to use. Choices are:
0 . | |||||
BAUD RATE | PTOS_SERIAL | Integer | 57600 | Baud rate. Choices are:
| |||||
PARITY | PTOS_SERIAL | String | None | Parity Bits are used to confirm data integrity. Only amend if the controller requires this. Choices are:
| |||||
STOP BITS | PTOS_SERIAL | Integer | 1 | Number of Stop Bits to be used. Only change this setting if the serial connection requires it. Almost all serial communication standards use 1 here. |
Payment Flow Options
- Apollo
- P6X
These options are ONLY available in the Advanced Configuration Section, and affect behaviour whilst in the Payment Flow only.
Setting Name | Tab Name | Data Type | Default Value | Description | ||
---|---|---|---|---|---|---|
present-card-button-type | nexo-terminal-config | String | none | Provides a confirmation or cancel option following a Start Session request. Choices are:
The button will always be at the left of the screen. | ||
present-card-button-text | nexo-terminal-config | String | N/A | In addition to defining the behaviour of a Present Card button, you can define the text specifically e.g. Back instead of the default Cancel when the type is cancel . | ||
present-card-selectable-languages | nexo-terminal-config | String | N/A | A space separated list of language codes (ISO 639-1) e.g. NL or EN can be provided here. When applied, a right hand side button with a Globe Icon is displayed. The requested languages will be selectable here. Language Selection will revert to the default when the Payment Flow is complete. If advanced language support is required, consider utilising UI commands to achieve this. A list of supported languages is available here. | ||
screen-saver-time | nexo-terminal-config | Integer | 120 | When using 'Always Scanning' mode, this setting will show the standard Screensaver after this number of seconds, even while the terminal is waiting for a card to be presented. This setting is separate to any UI Screensaver settings, as that will only trigger when the terminal is not in the Payment Flow. | ||
scap-present-card-title | nexo-terminal-config | String | N/A | You can define your own custom text to appear instead of "Present Card". Start Session & Read Card commands also allows this value to be set, and the value set in the Command will take precedence over this value. | ||
scap-present-card-subtitle | nexo-terminal-config | String | N/A | You can define your own custom text to appear underneath the title. "Present Card" will show here if the title is defined but subtitle is not. Start Session & Read Card commands also allows this value to be set, and the value set in the Command will take precedence over this value. | ||
card-hashes-append-data | nexo-terminal-config | String | N/A | Payter return a CardId in our Card Data field. By default, this is a secure and unique 'hashed' version of key card data and the terminal serial number. This ensures that the CardId is unique for each terminal and card. In some circumstaces however, Integrators may wish to accurately 'recognise' a CardId used originally on a different terminal. Setting this value to a consistent string, for all desired terminals, will replace the variable Serial Number in the secure hashing which will mean CardId 's can be consistent across the terminals configured in this way.Payter recommend that Integrators discuss this with the Integration Support team if it is required. |
There is only one adjustable P6X setting and it should be adjusted in Basic Settings under the 'General' tab. In this view, it is displayed in seconds.
Setting Name | Tab Name | Data Type | Default Value | Description |
---|---|---|---|---|
CARD_TIMEOUT | EmvConfig_Emv | String | none | How long in milliseconds a Start Session command will persist for. To turn off the timeout completely, please use 4294967295 . |