The Solo API connectivity option enables the POS PRO app to use the WiFi and Cloud connection over Bluetooth allowing further flexibility in sending payments to the card readers and reducing Bluetooth-related errors.
Solo API is an additional connection to the POS PRO app and not a replacement for the Bluetooth connection. If you wish to use the Bluetooth connection, you will be able to use it. The Solo API and Bluetooth connectivity cannot be used simultaneously.
Step 1: API Connection
To start the integration, you would need to follow the link HERE to the SumUp Developer Portal. You would need to sign into the SumUp Payments account which you would like the integration for.
After signing in, you will be presented with the below screen where you can generate an API Key by entering a name in the 'Name you API key' field and then tapping on 'Create' to generate the key.
Once the key has been generated this can be copied to be added in the backoffice in the following step.
Follow the link HERE to access the SumUp POS PRO backOffice SumUp Solo API setup page. Log in to the POS backoffice and enter the Sumup API Key which was copied from the SumUp Developer Portal then select 'Enable Integration' and click on 'Save Settings' to enable the integration.
The 'Lock API Key' is an optional setting that can be enabled to only allow Owner-level users to update the API keys.
Step 2: Generate the Pairing Code on the Solo Card Reader
Step 2 will be completed on the Solo card readers so before proceeding, please ensure the below conditions are met:
- Ensure the SumUp Solo is connected to a WiFi network.
The Solo Reader’s software version is 3.3.25.3 or higher (the latest version is recommended). You can find the guide to updating the Solo Card Reader by following the link HERE.
If you are updating the Solo Reader from version 21 or below, Then you need to log in with your MID first and then update the software from the Solo Reader’s settings page.
The Solo Reader is logged out the SumUp Payments account. If the account is signed in, you can swipe down on the Solo card reader and select Settings > About > Logout.
On the Solo Card Reader swipe down from the top of the screen to open the menu and select the 'Connections' option. In connections, you will find the 'API' option which can be enabled to allow transactions via the API.
Select 'Connect' to enable the connection for the API and a Unique Verification Code will be provided which will be required for the connection to the POS app.
Step 3: POS App setup
If you are operating with multiple tills in the outlet then the pairing process for the card reader would only need to be performed once which will allow all tills to access the card reader.
In the POS app Payment Settings, select the 'Solo API' tab and select 'Pair New Terminal' where you will be requested the Unique Verification Code and the name for the card reader which would be used to identify the card reader. Once the details have been added tap on 'Pair' to confirm pairing the card reader. This will then show the connected terminal on the list from where you can pair more terminals, view current connected terminals or disconnect the current terminal.
Payment Settings can be accessed via the POS PRO App > Settings Cog (top right) > Settings > Payment Settings.
On the Solo Card Reader, the status of the card reader should change to 'Connected - Ready to transact' once the device is paired successfully and on the main screen, it should show the 'Ready' status when it is connected.
Making Payments
Payments can be made using the Solo card reader with the same steps as any other payment option. You add the items to the order, select 'Pay' and then 'SumUp' which will send the payment amount to the default connected terminal.
Changing the default terminal/reader
Within the Payment Settings > SumUp, you will find the option for 'Paird Terminals'. Select this option to view all terminals which have previously been paired and you can tap on the new terminal which you would like to select as the default terminal. Once the default terminal has been changed, a 'tick' icon should appear next to the default terminal.
Disconnecting the Card Reader
To disconnect and unpair the card reader from the iPad, you can select the option 'Disconnect' under Payment Settings > SumUp. Once this option is selected, a pop-up should appear to allow you to confirm if you would like to disconnect and unpair the card reader.
If you are looking to remove the card reader from the Solo API connectivity completely then the card reader would need to be disconnected via the card reader connection settings. To disconnect, swipe down on the card reader to option the card reader menu, select 'Connections' > API > Disconnect. This will remove the API connection and you will then be able to enable other connections on the card reader (WiFi, Mobile Network and Bluetooth)
WARNING:
We have been made aware that while the SOLO API is active on the POS and card readers, that there is a battery drainage issue. We want to assure you that our team is actively working to identify the root cause of this issue and implement the necessary changes to address it. We understand the importance of reliable and efficient performance from our products, and we are committed to resolving this issue as soon as possible.
Relevant Links:
SumUp Developer Portal (API Keys): https://developer.sumup.com/api-keys
(POS) SumUp Solo API Settings: https://pos.thegoodtill.com/app/integrations/sumup_solo_api
SumUp Solo Update: https://help.sumup.com/en-GB/articles/352FZ2npYNpAVMzJLxFZnE-firmware-update
Solo Reader Reset - https://support.thegoodtill.com/sumup-air-reset-procedure#solo