Introduction
The Payter Session Protocol (PSP) is a local integration method. It is designed for solutions where the local device is the Integration Controller, and it establishes and maintains a connection to PSP so that it is always aware of the status of the terminal. This integration method is fast, and allows for complex interaction both with the terminal, and potentially third party RFID cards, that the Cloud Solution is less suitable for. It also allows the hardware supplier such as an EV charger manufacturer or a smart fridge vending machine manufacturer to include integrated functionality with their hardware solution, providing a more complete product offering.
About this Guide
PSP uses low level hex values to communicate, which can seem complicated at first glance. We've structured our guide to provide increasing levels of complexity, depending on your needs.
- If all that is needed for now is an understanding of the basics of how PSP works; What it does, how it communicates, and what functionality it offers, Payter recommend the PSP Overview section.
- In PSP Details, further and more detailed information on how PSP messages are constructed, and how PSP is enabled, configured and used, are provided. This section is ideal for anyone actively developing their local integration solution, or simply to determine more detail following the Overview.
- We split this section into:
- Format & Setup - how to structure PSP commands
- Example Flows - how card payment flows, and the correct command and logic to use at each stage
- Things to Consider - Optional functionality and other beneficial features that PSP can provide
- We split this section into:
- Finally, Detailed Messages is intended as a reference guide. Each specific command request and response are detailed separately, so they can be easily referred to when creating individual messages, or troubleshooting logs.
PSP & Payter Terminal Families
PSP is compatible with both the Payter P6X and Payter Apollo families. There are however several features which are specific to either the Apollo or the P6X terminal family
These are noted in each section like this, so they are easier to spot. The note will confirm what the limitation is.
Most messages however are generally limited in size for the P6X but less so for the Apollo family. As a result, multiple additional functionality in each message is Apollo Only. This will be marked in bold for each component.
Limited Functionality Examples
This request is only available on the APOLLO terminal family.
This request is only available on the P6X terminal family.
There are also some examples where the structure of the response will differ across each terminal family:
This request returns different data depending on the terminal family being used.