Capacitor.js SumUp plugin

A Capacitor.js bridge to SumUp native SDKs.

Install

npm install capacitor-sumup
npx cap sync

Import it into your project and enjoy the ride.

import { SumUp } from 'capacitor-sumup'

await SumUp.login({
    affiliateKey: 'YOUR-AFFILIATE-KEY',
    accessToken: 'YOUR-ACCESS-TOKEN'
})

Setup

iOS (update your Info.plist file)

NSLocationWhenInUseUsageDescription
NSBluetoothAlwaysUsageDescription
NSBluetoothPeripheralUsageDescription (unless your deployment target is at least iOS 13)

Android

Add the repository to your gradle dependencies (to your root build.gradle file)

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

Add the dependency to a module (to your module's build.gradle file)

implementation 'com.sumup:merchant-sdk:5.0.1'

Also, the minSdkVersion must be at least 26 in your Capacitor.js project.

API

• login(...)
• checkout(...)
• wakeUp()
• logout()
• Interfaces

login(...)

login(options: LoginOptions) => Promise<void>

Login to a SumUp account.

| Param | Type | | ------------- | ----------------------------------------------------- | | options | LoginOptions |

checkout(...)

checkout(options: CheckoutOptions) => Promise<CheckoutResult>

Make a payment on a card reader. Everything is handled by the internal SDKs.

| Param | Type | | ------------- | ----------------------------------------------------------- | | options | CheckoutOptions |

Returns: Promise<CheckoutResult>

wakeUp()

wakeUp() => Promise<void>

Prepare the connected card reader for a possible upcoming checkout.

logout()

logout() => Promise<void>

Disconnect and logout.

Interfaces

LoginOptions

| Prop | Type | Description | | ------------------ | ------------------- | ----------------------------------------------- | | affiliateKey | string | Affiliate key generated on the SumUp dev portal | | accessToken | string | Access token retrieved from SumUp API |

CheckoutResult

| Prop | Type | Description | | --------------------- | ------------------------------------ | ------------------------------------------------- | | transactionCode | string | Unique SumUp transaction ID of successful payment | | additionalInfo | { [key: string]: any; } | Additional infos returned by the SDKs |

CheckoutOptions

| Prop | Type | Description | | -------------------------- | ---------------------------- | ----------------------------------------------------------------------- | | amount | number | Amount to be charged | | currencyCode | string | null | ISO 4217 currency code. Defaults to HUF | | title | string | null | Message to be shown on specific card readers. Defaults to "Time to Pay" | | foreignTransactionID | string | null | Unique ID of the transaction on client side (optional) | | tipAmount | number | null | Amount to tip, works only on specific card readers | | skipReceiptScreen | boolean | null | Whether to skip the receipt screen on successful payment |