@sumup/react-native-checkout 0.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2019 SumUp Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,354 @@
+<div align="center">
+
+# SumUp React Native Checkout SDK
+
+</div>
+
+SumUp's React Native Checkout SDK provides a payment sheet that is displayed on top of your app. It collects user payment details, confirms a payment, and saves a card for future usage. Moreover, it allows a user to use Apple Pay or Google Pay to process payments.
+
+## Before You Begin
+
+Here are the things that you need in order to complete the steps in this guide:
+
+- You have a merchant account with [SumUp](https://me.sumup.com/login) and have already filled in your [account details](https://me.sumup.com/account).
+  - For a **test account** reach out to our support team through this [contact form](/contact).
+- You have [registered your client application](/docs/online-payments/introduction/register-app/) with SumUp.
+- You have a valid access token obtained via the [Authorization code flow](/docs/online-payments/introduction/authorization/#authorization-code-flow).
+- The restricted `payment_instruments` scope is enabled for your client application. If it isn't enabled, [contact us](/contact) and request it.
+- Review how to create a single payment [here](https://developer.sumup.com/docs/online-payments/guides/single-payment/#before-you-begin).
+
+## Requirements
+
+The initial requirements describe there https://developer.sumup.com/docs/online-payments/guides/single-payment/#before-you-begin
+
+You would need to create a checkout on your backend, then fetch checkout id and init an SDK with this identifier.
+
+### Payment Sheet
+
+SDK will process this checkout if a user provides card details. Otherwise, you receive an error.
+
+Checkout can be created by the following request:
+
+```sh
+curl --request POST \
+ --url https://api.sumup.com/v0.1/checkouts \
+ --header 'Authorization: Bearer <API KEY>' \
+ --header 'Content-Type: application/json' \
+ --data '{
+"checkout_reference": "44ea5096-b83f-46e1-9323-fe82a8cb7eb5",
+"currency": "SEK",
+"amount": 9.99,
+"description": "Order #1234",
+"merchant_code": "<MERCHANT CODE>",
+"return_url": "https://example.com",
+"redirect_url": "https://sumup.com"
+}'
+```
+
+### Save Card Sheet
+
+For saving cards, the flow is similar. The only difference is that the checkout should be created with a specific purpose. If the purpose is not passed, the SDK will return an error.
+
+Checkout can be created by the following request:
+
+```sh
+curl --request POST \
+ --url https://api.sumup.com/v0.1/checkouts \
+ --header 'Authorization: Bearer <API KEY>' \
+ --header 'Content-Type: application/json' \
+ --data '{
+"checkout_reference": "44ea5096-b83f-46e1-9323-fe82a8cb7eb5",
+"currency": "SEK",
+"amount": 9.99,
+"description": "Order #1234",
+"merchant_code": "<MERCHANT CODE>",
+"return_url": "https://example.com",
+"redirect_url": "https://sumup.com",
+"purpose": "setup_recurring_payment"
+}'
+```
+
+### Create a Customer
+
+A customer should be created to save the card for future usage.
+
+> **_NOTE:_** It's required for the Save Card sheet (which is used only for saving card details).
+
+> **_NOTE:_** It can be used in the Payment sheet to save a card for future usage. Additional information is below.
+
+```sh
+curl -L -X POST 'https://api.sumup.com/v0.1/customers' \
+-H 'Content-Type: application/json' \
+-H 'Accept: application/json' \
+-H 'Authorization: Bearer <TOKEN>' \
+--data-raw '{
+"customer_id": "831ff8d4cd5958ab5670",
+"personal_details": {
+"first_name": "John",
+"last_name": "Doe",
+"email": "user@example.com",
+"phone": "+491635559723",
+"birthdate": "1993-12-31",
+"address": {
+"city": "Berlin",
+"country": "DE",
+"line1": "Sample street",
+"line2": "ap. 5",
+"postal_code": "10115",
+"state": "Berlin"
+}
+}
+}'
+```
+
+More information about it you can find on [the website](https://developer.sumup.com/docs/api/create-a-customer/#create-a-customer).
+
+## Installation
+
+```sh
+yarn add @sumup/react-native-checkout
+yarn add react-native-webview react-native-safe-area-context @react-native-community/netinfo
+
+or
+
+npm i @sumup/react-native-checkout
+npm i react-native-webview react-native-safe-area-context @react-native-community/netinfo
+```
+
+You need to add fonts. For this create a `react-native.config.js` file in a root folder and put the following content:
+
+```js
+module.exports = {
+  dependecies: {},
+  project: {
+    ios: {},
+    android: {},
+  },
+  assets: ['./node_modules/@sumup/react-native-checkout/src/assets/fonts'],
+};
+```
+
+Then run the following command if your React Native version is below 0.69:
+
+```sh
+npx react-native link
+
+or
+
+yarn react-native link
+```
+
+or if the version is older than 0.69:
+
+```sh
+npx react-native-asset
+```
+
+You also need to install react-native-localization to automatically detect user system language. If you don't need it, please provide the language field in the `initPaymentSheet` function.
+
+```sh
+yarn add react-native-localization
+
+or
+
+npm i react-native-localization
+```
+
+or
+
+```js
+await initPaymentSheet({
+  checkoutId,
+  language: 'en',
+});
+```
+
+## iOS
+
+Install native modules
+
+```sh
+cd ios
+pod install
+```
+
+## Usage
+
+```js
+import { SumUpProvider } from '@sumup/react-native-checkout';
+
+export default function App() {
+  return (
+    <SumUpProvider publicKey="sup_pk_...">
+      <Screen />
+    </SumUpProvider>
+  );
+}
+```
+
+### Payment Sheet
+
+```js
+...
+import { useSumUp } from '@sumup/react-native-checkout';
+
+export default function Screen() {
+  const { initPaymentSheet, presentPaymentSheet } = useSumUp();
+
+  useEffect(() => {
+    initPayment();
+  }, []);
+
+  const initPayment = async () => {
+    const res = await initPaymentSheet({
+      checkoutId: '...',
+    });
+
+    console.log(res);
+  };
+
+  const onPress = async () => {
+    const res = await presentPaymentSheet();
+    console.log(res);
+  };
+
+  return (
+    <TouchableOpacity onPress={onPress}>
+      <Text>Show payment sheet</Text>
+    </TouchableOpacity>
+  );
+}
+```
+
+> **_NOTE:_** React Native has a known problem regarding showing 2 modals simultaneously. If you need to show an SDK from a modal, add a PaymentSheet component inside your modal.
+
+```js
+...
+import { PaymentSheet } from '@sumup/react-native-checkout';
+
+export default function Screen() {
+  ...
+
+  return (
+    <Modal>
+      ...
+      <PaymentSheet />
+    </Modal>
+  );
+}
+```
+
+### Save Card Sheet
+
+```js
+...
+import { useSumUp } from '@sumup/react-native-checkout';
+
+export default function Screen() {
+  const { initSaveCardSheet, presentSaveCardSheet } = useSumUp();
+
+  useEffect(() => {
+    initSDK();
+  }, []);
+
+  const initSDK = async () => {
+    const res = await initSaveCardSheet({
+      checkoutId: '...',
+      customerId: '...'
+    });
+
+    console.log(res);
+  };
+
+  const onPress = async () => {
+    const res = await presentSaveCardSheet();
+    console.log(res);
+  };
+
+  return (
+    <TouchableOpacity onPress={onPress}>
+      <Text>Show the Save Card sheet</Text>
+    </TouchableOpacity>
+  );
+}
+```
+
+## Prefilling Card Details
+
+Some card details can be prefilled. It can be used in the following way:
+
+```js
+await initPaymentSheet({
+  // ...
+  defaultCardDetails: {
+    cardHolderName: 'Some Name',
+    saveCardForFutureUsage: false, // false is the default value
+  },
+});
+
+await initSaveCardSheet({
+  defaultCardDetails: {
+    cardHolderName: 'Some Name',
+  },
+});
+```
+
+## Saving a Card for Future Usage in the Process the Payment Flow
+
+A card also can be saved when a user processes the payment. To enable it, the customer needs to be created. It can be done by the request that was described above.
+
+Then create a new checkout with the created `customerId`. And provide `customerId` to `initPaymentSheet` function.
+
+```js
+await initPaymentSheet({
+  // ...
+  customerId: '...',
+});
+```
+
+## Google Pay
+
+To use Google Pay, first enable the Google Pay API by adding the following to the <application> tag of your `AndroidManifest.xml`:
+
+<application>
+  ...
+  <meta-data
+    android:name="com.google.android.gms.wallet.api.enabled"
+    android:value="true" />
+</application>
+
+For more details, see Google Pay’s Set up Google Pay API for Android.
+
+Then provide `googlePay` object in `initPaymentSheet` to init.
+
+```js
+await initPaymentSheet({
+  // ...
+  googlePay: {
+    isProductionEnvironment: false,
+  },
+});
+```
+
+**_NOTE:_** This is only used in the Payment sheet!
+
+## Apple Pay
+
+**_NOTE:_** The backend doesn't process a payment with Apple Pay. An error message will be displayed after paying with it. It's a known issue and will be fixed!
+
+Register for an Apple Merchant ID
+Obtain an Apple Merchant ID by registering for a new identifier on the Apple Developer website.
+Fill out the form with a description and identifier. Your description is for your own records and you can modify it in the future.
+
+Then provide `applePay` object in `initPaymentSheet` to init.
+
+```js
+await initPaymentSheet({
+  // ...
+  applePay: {
+    merchantIdentifier: 'merchant.com.{{YOUR_APP_NAME}}',
+  },
+});
+```
+
+**_NOTE:_** This is only used in the Payment sheet!

package/android/build.gradle

@@ -0,0 +1,78 @@
+buildscript {
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:7.2.1"
+  }
+}
+
+def isNewArchitectureEnabled() {
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+apply plugin: "com.android.library"
+
+
+def appProject = rootProject.allprojects.find { it.plugins.hasPlugin('com.android.application') }
+
+if (isNewArchitectureEnabled()) {
+  apply plugin: "com.facebook.react"
+}
+
+def getExtOrDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["SumupReactNative_" + name]
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["SumupReactNative_" + name]).toInteger()
+}
+
+android {
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+  }
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+
+
+dependencies {
+  // For < 0.71, this will be from the local maven repo
+  // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
+  //noinspection GradleDynamicVersion
+  implementation "com.facebook.react:react-native:+"
+  implementation 'com.google.android.gms:play-services-wallet:19.1.0'
+}
+
+if (isNewArchitectureEnabled()) {
+  react {
+    jsRootDir = file("../src/")
+    libraryName = "SumupReactNative"
+    codegenJavaPackageName = "com.sumupreactnative"
+  }
+}

package/android/gradle.properties

@@ -0,0 +1,5 @@
+SumupReactNative_kotlinVersion=1.7.0
+SumupReactNative_minSdkVersion=21
+SumupReactNative_targetSdkVersion=31
+SumupReactNative_compileSdkVersion=31
+SumupReactNative_ndkversion=21.4.7075529

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.sumupreactnative">
+</manifest>