Starting with app version 1.15, you can log in to and out of the application directly from your own system using the deeplink API. This direct API-based login/logout capability eliminates the need for staff to switch to the standalone GP tom app and manually enter credentials—you can now manage the entire process from within your own application. This reduces the time required to activate the terminal, cuts down on login-related support inquiries, and—most importantly—simplifies workflows involving frequent staff or device rotations (such as shifts in hospitality or retail, or couriers sharing terminals between shifts).
Login to the app
Request
Deeplink path: gptom://login
Example call:
gptom://login?
username=merchant%40example.com&
password=strongpassword&
tid=123456&
redirectUrl=gp%3A%2F%2Flogin
If the ERROR state returns error=passwordChangeRequired, it indicates the user's first login, and the flow described below must be followed.
Initial login to the application with password change
If the user has not yet set a password for deeplink login (first-time login), the login call returns the error `passwordChangeRequired`. In this case, it is necessary to send a `change-password` deeplink in two steps.
Request
Deeplink path: gptom://change-password
Step 1 – without requesting a verification code
A call without the Code parameter. Upon success (status=COMPLETED, no error), the system sends a verification code to the user's email.
gptom://change-password?
username=merchant%40example.com&
password=strongpassword&
newPassword=NewStrongPassword1&
tid=123456&
redirectURL=gp%3A%2F%2Fchange-password
Step 2 – Confirmation via code
The same call, including the code parameter sent via email. Upon success, the password is changed, and you can proceed with a standard login.
gptom://change-password?
username=merchant%40example.com&
password=strongpassword&
newPassword=NewStrongPassword1&
tid=123456&
code=AsfweWW41515&
redirectURL=gp%3A%2F%2Fchange-password
Logging out of the app
Request
Deeplink path: gptom://logout
gp://logout?redirectUrl=gp%3A%2F%2Flogout
Status codes
EN: Request completed successfully.
EN: Request failed — see the error parameter for details.
EN: The user cancelled the request within the GP tom app.
Error codes relevant to login/logout
EN: Invalid username or password.
EN: The TID provided has not been assigned to this user.
EN: The TID provided is already in use by another user.
EN: The same user is already logged in on this device with a different TID.
EN: First login – you must set a password first.
EN: This happens the first time you log in after step 1, when an authorisation code is sent by email.
EN: The confirmation code provided for the password change is invalid.
EN: It was not possible to log the user in.
EN: Incorrect credentials were sent.
EN: Terminal setup has failed. Please contact our support team.
Login status verification
To determine whether the user is already logged into the GP tom application, you can call the Get status method. This method allows you to retrieve current information about the application's status and the logged-in merchant. Detailed information regarding the method's usage and implementation can be found in the iOS documentation for the Get status method.