Terminal Agent is a SensePass software designed to connect platforms to SensePass network with a range of EMV pinpads and to simplify the integration process, allowing for quick setup and deployment.
Terminal Agent also works as a proxy to all SensePass cloud API describes in this portal.
In addition, Terminal agent allows you to use specific API's created for the Terminal Agent software to reduce the integration time.
Pairing of tags and EMV devices is already implemented
Terminal Agent handles the pairing process for all types of terminals and tags using SensePass UI
Storing API keys, Device ID's and EMV ID's is already implemented
Terminal Agent stores all the credentials and authentication keys and append them automatically to all of your requests
Implementing Web-sockets or Callback endpoint is already implemented
Terminal Agent internal logic works with Socket.IO websockets securely, according to SensePass interface and returns synchronous response to your platform
Integrating using Terminal Agent enables you to support new features and releases without any change on your end
Most of the new features that will be released to our API will be available to you seamlessly by updating the Terminal Agent software on the POS, without having to change one line of code on your platform
Integration with the Cancel API is already implemented
Terminal Agent detects the cancel event of the HTTP request for Synchronous Payment API and calls internally to the "Cancel" API in order to revoke the pending payment request
Terminal Agent software is already certified by SensePass
Integration using Terminal Agent reduces most of the certifcation process for your platform
System Requirements: Operating System: Compatible with Windows 7, 8, 10, and newer versions.
Terminal Agent expose synchronous payment request call that reduce the integration time and logics.
Call POST request to: http://localhost:8003/api/transactions/init/sync Use the same schema as - Create a transaction
DeviceId field is not required - Terminal agent will append it automatically
Cancelling the payment request can be done using cancelling the HTTP request from #1
On final result (Approve, timeout or Cancel) - you will get response to this request
See full docs about sync payment request
Terminal Agent expose an API to recover from network issue while using the Sync payment API,
in event of error or closed connection, you can use this API to fetch the current status of the last transaction created.
Call GET request to: http://localhost:8003/api/transactions/last Without any request payload
DeviceId field is not required - Terminal agent will append it automatically
Reponse will return immediately according to Transaction Status schema
See full docs about last transaction status API
Reduces the intergation time: Pairing, cancelling request and working with websockets logics are already embeded inside terminal agent
Compatibility with Various Pinpads: Terminal Agent supports a wide array of EMV pinpad models and manufacturers, enhancing its utility in diverse environments.
Easy Integration: Designed for effortless setup, enabling quick deployment across multiple terminals.
Real-time Monitoring: Ensures continuous operation with live monitoring capabilities.
Automatic Updates: Keeps the system up-to-date with the latest features and security patches without manual intervention.
Terminal Agent expose synchronous payment request call that reduce the integration time and logics.
Call POST request to: http://localhost:8003/api/transactions/init/sync Use the same schema as - Create a transaction
DeviceId field is not required - Terminal agent will append it automatically
Cancelling the payment request can be done using cancelling the HTTP request from #1
On final result (Approve, timeout or Cancel) - you will get response to this request
URL: http://localhost:8003/api/transactions/init/sync
Request Body:
Response body:
Terminal Agent works as a proxy to all SensePass cloud API describes in this docs.
In addition, Terminal agent allows you to use specific API's created for the Terminal Agent software.
Stroing and sending Device ID in the request body is not required for all API requests, Terminal Agent stores and will append this data to your requests automatically.
Instead of calling our cloud API (api.sensepass.com / api.sandbox.sensepass.com) - just change the base URL of your requests to http://localhost:8003/
Example: http://localhost:8003/api/transactions/init
The schema of this requets is identical to the cloud API.
Double click on "SensePass Configurator" icon on your desktop, if you can't find it - open your browser with this URL: http://localhost:3031
Make sure you are using Chrome or Edge with the latest version installed
This screen will be shown:
Location - Choose the current location for your POS, adding locations to this list can be performed using the Partners platform
EMV - Choose the required pinpad type
POS Name - friendly name for the POS that will be shown in the merhcnat dashboard to recognize your payments
Pairing Code - the (XXX-XXX-XXX) code that is shown below the QR code on the SensePass tag
Click on the "Continue" button and close the window after the succesful pairing message presented.
All set !
Ensure your system meets the mentioned requirements
Login to SensePass Partners
Navigate to "Developers" -> "Terminal Agent"
Download the latest version of Terminal Agent software using the download link on the partners page
Click on the green button "Download config file"
Double click on the EXE file in your downloads folder and start the installation process
Click on "I agree" and click "Install"
Setup will complete with this message:
Move the config.json file from #5 to this location:
C:\Program Files (x86)\SensePass Ltd\Terminal Agent
Open the Services app (Run -> services.msc)
Look for "SensePass-Agent-V2", right click -> Restart
Terminal Agent expose an API to recover from network issue while using the Sync payment API,
in event of error or closed connection, you can use this API to fetch the current status of the last transaction created.
Call GET request to: http://localhost:8003/api/transactions/last Without any request payload
DeviceId field is not required - Terminal agent will append it automatically
Reponse will return immediately according to Transaction Status schema
URL: http://localhost:8003/api/transactions/last
Response body:
