PointCheckout Merchant SDK

These are the minimum required steps to use the PointCheckout SDK in your Android app. We assume that you are using Android Studio for your Android development. The minimum supported Android API level for the SDK is 16 (KitKat), however, setting the minimum Android API level to 26 (Pie) is recommended.

The SDK uses Google's SafetyNet API for security, setting minimum Android API to lower than 26 will prevent it from functioning.

Getting started

Add the SDK to your project:

• Add the following to YourProject/build.gradle

    allprojects {
        repositories {
            ...
            maven { url 'https://jitpack.io' }
        }
    }

• Add the following dependency to YourProject/app/build.gradle

  dependencies {
          implementation 'com.github.pointcheckout.android-sdk:android-sdk:v1.4-b6'
  }

Add permissions

The PointCheckout SDK requires the following permissions. Please add them to your AndroidManifest.xml file if they are not already present:

<uses-permission android:name="android.permission.INTERNET"/>

Adding SafetyNet

Add Google's SafetyNet API to your app/build.gradle, follow this guide.

After these steps, rebuild your app and you are good to go!

Using the SDK

The bellow diagram shows how the payment process works:

Checkout request

Send new checkout request to PointCheckout's API (check the documentation for more details).

Create PointCheckoutClient

Create an object of PointCheckoutClient:

PointCheckoutClient pcClient = new PointCheckoutClient(environment);

environment: specifies the environment of the app, use Environment.TEST for testing purposes.

Keep a reference of the created client to reuse the same instance

Initialize

Initialize the created PointCheckoutClient using:

pcClient.initialize(context);

Invoke initialize when the app starts because it needs 2-3 seconds. If the client is not initialized and pay is called, the client will call initialize internally before calling pay.

Payment submit

To submit a payment call the static pay method of the PointCheckoutClient:

pcClient.pay(context, checkoutKey, new PointCheckoutEventListener() {
                @Override
                public void onUpdate() {
                    System.out.println("UPDATE CALLBACK");
                }

                @Override
                public void onDismiss() {
                    System.out.println("USER CLOSED THE MODAL");
                }
        });

Parameter	Description
context	Current activity context
checkoutKey	This key is included in the checkout response from PointCheckout API
listener	Listener that will be called on payment update or cancellation

Calling the pay function will open a modal and the user will be able to login and complete the payment.

PointCheckoutEventListener

PointCheckoutEventListener has two callbacks, onUpdate and onDismiss.

onUpdate will be called whenever the checkout status is updated (paid, cancelled, failed .etc). When this callback is invoked you should call PointCheckout API to fetch the new status of the checkout.

onDismiss will only be called if the user closes the modal by clicking on close button.

Demo app

You can use our Demo app as an example of how to integrate our SDK on your application. you can access it from here. You can import the example app to Android Studio to see how the SDK can be used.