capacitor-pay-sumup

SumUp provider plugin for @capacitor-pay/core, wrapping the SumUp SDK for in-app card and Tap to Pay checkout. Can also be used standalone without @capacitor-pay/core.

Install

npm install @capacitor-pay/sumup
npx cap sync

Android setup

This plugin depends on the SumUp Merchant SDK for Android (com.sumup:merchant-sdk:7.0.0), which:

• requires minSdkVersion 26 or higher in your app's android/variables.gradle
• is hosted on SumUp's own Maven repository

If your app uses Gradle's centralized repository management (dependencyResolutionManagement in android/settings.gradle), add SumUp's repository there:

dependencyResolutionManagement {
    repositories {
        // ...existing repositories
        maven { url 'https://maven.sumup.com/releases' }
    }
}

(The plugin's build.gradle already declares this repository for older, non-centralized setups, so most projects need no extra configuration.)

Tap to Pay

checkTapToPay() / activateTapToPay() wrap Tap to Pay on iPhone and are iOS-only. On Android, checkTapToPay() resolves { available: false, activated: false } and activateTapToPay() rejects. SumUp's Tap to Pay on Android is a separate SDK (requiring dedicated Maven credentials from SumUp) and is not bundled here.

API

• setup(...)
• login(...)
• isLoggedIn()
• getCurrentMerchant()
• logout()
• prepareForCheckout()
• checkout(...)
• openCheckoutPreferences()
• checkTapToPay()
• activateTapToPay()

setup(...)

setup(options: { affiliateKey: string }) => Promise<{ success: boolean }>

Configure the SDK with a SumUp affiliate key. Call once before login/checkout.

login(...)

login(options: { accessToken: string }) => Promise<{ success: boolean }>

Log in to a SumUp merchant account using an OAuth access token.

isLoggedIn()

isLoggedIn() => Promise<{ isLoggedIn: boolean }>

Check whether a merchant is currently logged in. The session persists across app restarts, so call this on launch to decide whether login() is needed.

getCurrentMerchant()

getCurrentMerchant() => Promise<SumUpMerchant>

Get the currency and merchant code of the currently logged-in merchant. Both fields are null if no merchant is logged in. Useful for validating that checkout()'s currency matches the merchant's currency before presenting checkout.

logout()

logout() => Promise<{ success: boolean }>

Log out of the current SumUp merchant account.

prepareForCheckout()

prepareForCheckout() => Promise<void>

Let the SDK know that a checkout is imminent (e.g. while the user is entering an amount), so it can take steps like waking a connected card reader ahead of time.

checkout(...)

checkout(options: SumUpCheckoutOptions) => Promise<SumUpCheckoutResult>

Present the SumUp checkout flow for a single payment. options accepts an optional tipAmount and foreignTransactionID. The resolved result includes a transactionCode for reconciling the payment with SumUp's REST API, and (iOS only) additionalInfo with card details.

openCheckoutPreferences()

openCheckoutPreferences() => Promise<{ success: boolean }>

Present SumUp's checkout preferences screen, where the merchant can pair/configure a card reader and adjust checkout settings.

checkTapToPay()

checkTapToPay() => Promise<SumUpTapToPayStatus>

Check whether Tap to Pay on iPhone is available and activated for this device/account. Always resolves { available: false, activated: false } on Android, which does not support Tap to Pay through this plugin.

activateTapToPay()

activateTapToPay() => Promise<{ success: boolean }>

Present the Tap to Pay on iPhone activation flow. Rejects on Android, which does not support Tap to Pay through this plugin.