Skip to content
SumUp Developer

Affiliate Keys

Learn about the role of Affiliate Keys at SumUp

SumUp uses Affiliate Keys to identify critical metrics such as Total Processing Volume coming through a Partner’s integration. The key associates all merchant account users of the Affiliate Key with the partner, allowing SumUp to enforce agreed terms such as fast onboarding, revenue share, and transaction fees. For that reason, Affiliate Keys are mandatory for card-present integrations, such as:

Affiliate keys are not an authorization mechanism. Use them together with either API keys or OAuth 2.0 depending on how your integration calls SumUp APIs.

Create Affiliate Key

Section titled “Create Affiliate Key”
  1. Log in to your SumUp account.
  2. Expand your user account menu and open Settings.
  3. Go to For Developers > Toolkit.
  4. Select Affiliate Keys. The page shows the Application identifier field if no key exists, or lists existing keys.
  5. Enter the Application identifier matching the App ID/Bundle ID from your development project (such as com.example.app).
  6. Select Add. The key is generated, and the App ID is assigned to it. You can add more App IDs to the key if you need to integrate more apps, but the key itself is immutable.

Example Usage

Section titled “Example Usage”

The Solo Terminal API includes the Affiliate Key in the Reader Checkout Request under the affiliate section:

  • app_id: This is the aforementioned application ID.
  • key: This is the Affiliate key unique to each account and mandatory for every merchant in their checkout requests.
{
  "affiliate": {
    "app_id": "your_application_id",
    "key": "your_affiliate_key"
  },
  "checkout": {
    "amount": 10.0,
    "currency": "EUR",
    "description": "Test Transaction"
  }
}

What’s Next?

Section titled “What’s Next?”

Check the following resources to build your integration: