{"_id":"@capacitor-pay/sumup","name":"@capacitor-pay/sumup","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@capacitor-pay/sumup","version":"0.0.1","description":"Capacitor plugin wrapping the SumUp SDK for in-app card and Tap to Pay checkout. SumUp provider for capacitor-pay.","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Alessio Spanu"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/capacitor-pay/capacitor-pay-sumup.git"},"keywords":["capacitor","plugin","native","sumup","payments"],"scripts":{"build":"npm run clean && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/core":"^8.1.0","rimraf":"^6.0.1","rollup":"^4.30.1","typescript":"~5.6.3"},"peerDependencies":{"@capacitor/core":">=7.0.0"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"gitHead":"b586e3edecbdf543b3d42981fb94241df1feb7f1","_id":"@capacitor-pay/sumup@0.0.1","bugs":{"url":"https://github.com/capacitor-pay/capacitor-pay-sumup/issues"},"homepage":"https://github.com/capacitor-pay/capacitor-pay-sumup#readme","_nodeVersion":"25.7.0","_npmVersion":"11.10.1","dist":{"integrity":"sha512-29+1uj00/S31bFvY6XKfgT7AqlLqyFZ14oWSjhsPl69RmUykEF2FMAVmfYlVVQ5r7+RQl8ZoDiCl4e9/I0JJcA==","shasum":"0811f08a78def7765aeaa3660ae23ffd589c204f","tarball":"https://registry.npmjs.org/@capacitor-pay/sumup/-/sumup-0.0.1.tgz","fileCount":22,"unpackedSize":45505,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIB/R0M0jkYLtRS863Vkk5z9m5Yev47g7YlcW9VQIWyapAiBv8aVhWieHHVefyOENa1VZNCgTCuVfVQlbAr5GONm3GA=="}]},"_npmUser":{"name":"spanu18","email":"alessio.spanu03@gmail.com"},"directories":{},"maintainers":[{"name":"spanu18","email":"alessio.spanu03@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sumup_0.0.1_1781530019243_0.4568578772628078"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-15T13:26:59.005Z","0.0.1":"2026-06-15T13:26:59.397Z","modified":"2026-06-15T13:26:59.741Z"},"maintainers":[{"name":"spanu18","email":"alessio.spanu03@gmail.com"}],"description":"Capacitor plugin wrapping the SumUp SDK for in-app card and Tap to Pay checkout. SumUp provider for capacitor-pay.","homepage":"https://github.com/capacitor-pay/capacitor-pay-sumup#readme","keywords":["capacitor","plugin","native","sumup","payments"],"repository":{"type":"git","url":"git+https://github.com/capacitor-pay/capacitor-pay-sumup.git"},"author":{"name":"Alessio Spanu"},"bugs":{"url":"https://github.com/capacitor-pay/capacitor-pay-sumup/issues"},"license":"MIT","readme":"# capacitor-pay-sumup\n\nSumUp provider plugin for [`@capacitor-pay/core`](https://github.com/capacitor-pay/capacitor-pay), wrapping the SumUp SDK for in-app card and Tap to Pay checkout. Can also be used standalone without `@capacitor-pay/core`.\n\n## Install\n\n```bash\nnpm install @capacitor-pay/sumup\nnpx cap sync\n```\n\n## Android setup\n\nThis plugin depends on the SumUp Merchant SDK for Android (`com.sumup:merchant-sdk:7.0.0`), which:\n\n* requires `minSdkVersion 26` or higher in your app's `android/variables.gradle`\n* is hosted on SumUp's own Maven repository\n\nIf your app uses Gradle's centralized repository management (`dependencyResolutionManagement` in `android/settings.gradle`), add SumUp's repository there:\n\n```gradle\ndependencyResolutionManagement {\n    repositories {\n        // ...existing repositories\n        maven { url 'https://maven.sumup.com/releases' }\n    }\n}\n```\n\n(The plugin's `build.gradle` already declares this repository for older, non-centralized setups, so most projects need no extra configuration.)\n\n### Tap to Pay\n\n`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.\n\n## API\n\n<docgen-index>\n\n* [`setup(...)`](#setup)\n* [`login(...)`](#login)\n* [`isLoggedIn()`](#isloggedin)\n* [`getCurrentMerchant()`](#getcurrentmerchant)\n* [`logout()`](#logout)\n* [`prepareForCheckout()`](#prepareforcheckout)\n* [`checkout(...)`](#checkout)\n* [`openCheckoutPreferences()`](#opencheckoutpreferences)\n* [`checkTapToPay()`](#checktaptopay)\n* [`activateTapToPay()`](#activatetaptopay)\n\n</docgen-index>\n\n### setup(...)\n\n```ts\nsetup(options: { affiliateKey: string }) => Promise<{ success: boolean }>\n```\n\nConfigure the SDK with a SumUp affiliate key. Call once before login/checkout.\n\n### login(...)\n\n```ts\nlogin(options: { accessToken: string }) => Promise<{ success: boolean }>\n```\n\nLog in to a SumUp merchant account using an OAuth access token.\n\n### isLoggedIn()\n\n```ts\nisLoggedIn() => Promise<{ isLoggedIn: boolean }>\n```\n\nCheck whether a merchant is currently logged in. The session persists across app restarts,\nso call this on launch to decide whether `login()` is needed.\n\n### getCurrentMerchant()\n\n```ts\ngetCurrentMerchant() => Promise<SumUpMerchant>\n```\n\nGet the currency and merchant code of the currently logged-in merchant. Both fields are\n`null` if no merchant is logged in. Useful for validating that `checkout()`'s `currency`\nmatches the merchant's currency before presenting checkout.\n\n### logout()\n\n```ts\nlogout() => Promise<{ success: boolean }>\n```\n\nLog out of the current SumUp merchant account.\n\n### prepareForCheckout()\n\n```ts\nprepareForCheckout() => Promise<void>\n```\n\nLet the SDK know that a checkout is imminent (e.g. while the user is entering an amount),\nso it can take steps like waking a connected card reader ahead of time.\n\n### checkout(...)\n\n```ts\ncheckout(options: SumUpCheckoutOptions) => Promise<SumUpCheckoutResult>\n```\n\nPresent the SumUp checkout flow for a single payment. `options` accepts an optional\n`tipAmount` and `foreignTransactionID`. The resolved result includes a `transactionCode`\nfor reconciling the payment with SumUp's REST API, and (iOS only) `additionalInfo` with\ncard details.\n\n### openCheckoutPreferences()\n\n```ts\nopenCheckoutPreferences() => Promise<{ success: boolean }>\n```\n\nPresent SumUp's checkout preferences screen, where the merchant can pair/configure a card\nreader and adjust checkout settings.\n\n### checkTapToPay()\n\n```ts\ncheckTapToPay() => Promise<SumUpTapToPayStatus>\n```\n\nCheck whether Tap to Pay on iPhone is available and activated for this device/account.\nAlways resolves `{ available: false, activated: false }` on Android, which does not\nsupport Tap to Pay through this plugin.\n\n### activateTapToPay()\n\n```ts\nactivateTapToPay() => Promise<{ success: boolean }>\n```\n\nPresent the Tap to Pay on iPhone activation flow.\nRejects on Android, which does not support Tap to Pay through this plugin.\n","readmeFilename":"README.md","_rev":"1-1fc9809c7443ad7c9967ddc7bcf0aedd"}