SPIn specification API
Version History
| Date | Version | Details |
|---|---|---|
| 10/01/22 | 1.0 | Initial release |
| 10/10/22 | 1.1 | Added support for Tags |
| 11/01/22 | 1.2 | Added support for iPOSToken |
| 20/02/23 | 1.3 | Added PerformedBy Tag |
| 5/04/23 | 1.4 | Added userChoice option to PaymentType |
| 21/07/23 | 1.5 | Added support for user input and summary reports to fetch batch details from the payment device. |
| 06/02/24 | 1.7 | Added support for level data, dual pricing requests, and the ISVID indicator. |
| 10/09/24 | 1.8 | Enabled cart Items display API |
| 12/12/24 | 1.9 | Added fee support tag in sale request |
| 09/06/24 | 1.10 | Added Multi MerchantId |
| 07/07/25 | 2.0 | Added Get Card API support |
| 25/07/25 | 2.1 | Added dynamic capabilities for display cart items API |
| 03/10/25 | 2.2 | Updated data tags for Level 3 and new VISA CEDP line item acceptance |
| 18/11/25 | 2.3 | Added new ReconId tag for Fiserv reconciliation support |
| 05/03/26 | 2.4 | EBT Balance API support |
| 08/04/26 | 2.5 | Added Reduced Tax and State Tax |
| 24/04/26 | 2.6 | Added support for AutoRental |
| 26/06/26 | 2.7 | Added prefill CustomerEmail and CustomerMobile |
Prerequisites
-
iPOSpays-powered Dejavoo terminal
-
Login credential to iPOSpays
For Sandbox (UAT)
Users should be onboarded on iPOSpays sandbox(UAT) environment as a merchant and have a valid TPN.
For Production (Live)
Users should be onboarded on iPOSpays production environment as a merchant and have a valid TPN.
If you do not have a TPN, contact your ISO or devsupport@dejavoo.io
Steps to Setup
Step 1: Login to iPOSpays
Step 2: Enable SPIn for your TPN.
- Go to S.T.E.A.M -> Edit Parameters -> search and select your TPN
- Click Edit Parameter
- Click Integrations
- Under Type of Integrations, select SPIn and choose Cloud under Spin Mode.
- Copy the Register ID and Auth Key. You will need these values when calling the API from the Host System.
Watch This Video for a Visual Walkthrough of the Steps
SPIn Proxy (Troubleshooting)
SPIn proxy helps integrators ensure the connection is established between SPIn and the payment terminal.
- Login to iPOSpays
- Click “Troubleshooting SPIn Proxy”
- Enter your TPN
- Click “Check POS Connection”
If the arrow between the SPIn logo and the payment terminal logo is lit up in green, it indicates that the connection has been successfully established. If the arrow is lit up in red, it means the connection has not been established and there is an issue. In this case, please reach out to us at support@dejavoosystems.com.
We also offer simulated testing to verify if the generated Auth Key and TPN are working and ready to be configured with the Host System.
TPN & Auth Key Check – Short Steps:
TPN Check:
- Click “Check Register Connection” and select “Show TPN.”
- Confirm pop-up on the terminal.
- Verify the connection:
- If the arrow light is green, the TPN will appear on the portal, indicating a successful connection.
- If the arrow light is red, the connection has failed. For failed connections, contact support at support@dejavoosystems.com.
Auth Key Check:
- Click “Check Register Connection” and select “Show Auth Key.”
- Confirm pop-up on the terminal.
- Verify the connection:
- If the arrow light is green, the Auth Key will appear on the portal, indicating a successful connection.
- If the arrow light is red, the connection has failed. For failed connections, contact support at support@dejavoosystems.com.
Sample Source Code
Error Codes and Their Meaning
For a complete list of error codes and their explanations, please visit our Error Codes Reference Page.
Last updated on