Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/docs/tools/api/affiliate-keys.mdoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ fees. For that reason, **Affiliate Keys are mandatory for card-present integrati

* Mobile SDKs including Android SDK and [iOS SDK](/tools/sdks/ios-sdk/)
* [API Payment Switch](/tools/payment-switch/)
* [Solo API (Cloud API)](/tools/sdks/cloud-api/)
* [Solo API (Cloud API)](/tools/api/cloud-api/)

Affiliate keys are NOT part of any authorization mechanism as such. They are used by SumUp in card-present integrations to attribute the payments to a specific integration.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/tools/api/authorization.mdoc
Original file line number Diff line number Diff line change
Expand Up @@ -176,4 +176,4 @@ Check the following resources to build your integration:
* [Android SDK Guide](https://github.com/sumup/sumup-android-sdk)
* [PHP SDK Guide](/tools/sdks/php-sdk/)
* [React Native SDK](/tools/sdks/react-native-sdk/)
* [Cloud API for the Solo Card Reader](/tools/sdks/cloud-api/)
* [Cloud API for the Solo Card Reader](/tools/api/cloud-api/)
25 changes: 19 additions & 6 deletions src/content/docs/tools/api/cloud-api.mdoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Taking Solo Payments with Cloud API
sidebar:
label: SOLO API
label: Cloud API
order: 23
---

Expand Down Expand Up @@ -29,6 +29,11 @@ The Cloud API integration supports:

* Your device must be authorized to use the Cloud API. [Read the authorization guide](/tools/api/authorization/) and implement a method that best fits your use case. The API key should be sufficient if you do not intend to delegate access to third parties.
* You need to [create an Affiliate Key](/tools/api/affiliate-keys/) for your app. SumUp Cloud API requires the Affiliate Key to be present in checkout requests.
* We strongly recommend keeping the Solo terminal plugged-in when using Cloud API.
* If you want to use mobile data, make sure that you're not connected to a Wi-Fi network. Disconnect if you are -
in case both mobile data and Wi-Fi is available, Solo reader will always use Wi-Fi.

To disconnect Wi-Fi, go to **Connections** > **Wi-Fi** and disable Wi-Fi using the on-screen slider.

## Pairing Solo Reader via Cloud API

Expand All @@ -55,6 +60,15 @@ sequenceDiagram
A ->> A: Present Checkout to Customer
```

### Log Out of Solo

Cloud API pairing process is only available for logged-out users. If you're logged in to your merchant account, do as follows:

1. Open the top-side menu on your Solo.
2. Select **Settings**. The **Device settings** menu opens.
3. Go to the **About** section.
4. Select **Log out**. Solo should now display the login screen.

### Generate Pairing Code

In order to initiate a payment on the Solo card reader, the device must be enrolled with the
Expand All @@ -64,21 +78,20 @@ when the target device successfully completes a pairing request using the Cloud
Both your application and the Solo card reader need to be connected to the internet (it doesn't have to be the same network).

{% aside type="note" %}
The pairing process has an expiration time of 5 minutes, if any issue occurs, the whole

The pairing process has an expiration time of 5 minutes, if any issue occurs, the
process must be restarted.

{% /aside %}

{% steps %}
1. Turn on the Solo card reader
2. Make sure you're not logged in. Log out from your Solo card reader if you are.
1. Turn on the Solo card reader.
2. Make sure you're not logged in. [Log out from your Solo card reader](#log-out-of-solo) if you are.
3. Open the top menu drawer
4. Go to **Connections** and connect to Wi-Fi (connecting is skipped in the short video below).
5. Select **API**.
6. Click **Connect**. The pairing code is generated.
7. Copy the pairing code displayed on the
Solo card reader screen. You will need this code to pair your Solo reader with your device.
{% /steps %}

{% video src="/img/guides/pair_solo.mp4" trackSrc="/img/guides/pair_solo.vtt" width="400px" height="400px" /%}

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/tools/index.mdoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ sidebar:
/%}

{% cardlink
href="/tools/sdks/cloud-api/"
href="/tools/api/cloud-api/"
title="Card reader payments"
description="Integrate card payments from any platform using Cloud API."
image="/img/api-call.svg"
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.astro
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ const props = {
image="/img/swift-checkout.svg"
/>
<CardLink
href="/tools/sdks/cloud-api/"
href="/tools/api/cloud-api/"
title="Card reader payments"
description="Integrate card payments from any platform using Cloud API."
image="/img/api-call.svg"
Expand Down