hyper-sdk-plugin

HyperSDK Cordova plugin

Table of Contents

• About
• SDK API

About

Cordova plugin for HyperSDK.

Minimum Requirement

Android

The minimum version of cordova-android supported with HyperSDK is 10.0.0 which uses androidx and AppCompatActivity.

Getting the SDK

SDK is available as a node dependency via:

cordova plugin add hyper-sdk-plugin

Updating your clientId

Android

Update your clientId provided by Juspay Support Team in the ext block of the root(top) build.gradle file present under platforms/android/build.gradle.

    ext {
        clientId = "<clientId provided by Juspay Team>"
        hyperSDKVersion = "2.1.24"
    }

Optionally, you can also provide an override for base SDK version present in plugin (the newer version among both would be considered).

iOS

Update your clientId provided by Juspay Support Team in the MerchantConfig.txt file present under platforms/ios/

clientId = <clientId shared by Juspay Team>

SDK API

Create an instance for HyperSDK cordova plugin by using:

hyperSDKRef = cordova.plugins.HyperSDKPlugin

EC Headless - All payload ref is available at HyperSDK EC doc. Payment Page - All payload ref is available at HyperSDK Payment page doc.

PreFetch

To keep the sdk up to date with the latest changes, it is highly recommended to call preFetch as early as possible. To call preFetch, use the following snippet:

var payload = {
    "service" : "in.juspay.hyperpay",
    "betaAssets" : true,
    "payload" : {
        "clientId" : "<client_id>"
    }
}
hyperSDKRef.preFetch(JSON.stringify(payload))

Initiate

To serve dynamically changing requirements for the payments ecosystem HyperSDK uses a JS engine to improve user experience and enable faster iterations. Initiate API starts up the js engine and enables it to improve the performance and experience of the next SDK API calls. To call initiate, use the following snippet:

var payload = {
    "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a",
    "service" : "in.juspay.hyperpay",
    "betaAssets" : true,
    "payload" : {
        "action": "initiate",
        "merchantKeyId": "2980",
        "merchantId": "merchant_id",
        "clientId": "merchant_id" + "_android",
        "customerId": "customer_id",
        "environment": "sandbox",
        "signaturePayload": "signaturePayloadString",
        "signature": "signature"
    }
}
hyperSDKRef.initiate(JSON.stringify(completePayload), hyperSDKCallback);

Initiate payload - All payload ref is available at HyperSDK initiate.

Process

Process api helps with all the required operation to be triggered via HyperSDK. Responses and various events triggered are streamed back to callback passed in Initiate.

var payload = {
    "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a",
    "service" : "in.juspay.hyperpay",
    "betaAssets" : true,
    "payload" : {
        "action": "paymentPage",
        "merchantKeyId": "2980",
        "merchantId": "merchant_id",
        "clientId": "merchant_id" + "_android",
        "customerId": "customer_id",
        "environment": "sandbox",
        "signaturePayload": "signaturePayloadString",
        "signature": "signature"
    }
}
hyperSDKRef.process(JSON.stringify(completePayload));

Process payload - All payload ref is available at HyperSDK process.

Optional: isInitialised

This is a helper / optional method to check whether SDK has been initialised after step-2. It returns a boolean value in the callback function.

hyperSDKRef.isInitialised((response) => {
    // Make process call here if response is true
});

License

hyper-sdk-plugin (HyperSDK Cordova) is distributed under AGPL-3.0-only license.