JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Initiating the SDK

To initialise the SDK, client needs to call the initiate SDK API. The initiate api call boots up Express Checkout SDK and makes it ready for all other operations

Follow the below steps to make an initiate SDK call

Initiate is to be called in the onCreate() method of your application's main activity (Home screen). Not following this will lead to increased latency.

Step 1

Import HyperSDK

Step 2

Create an instance of HyperServices

Step 3

Create Initiate payload

Initiate API takes two parameters as input. One of the parameter is a JSON object referred as InitiatePayload. This payload contains certain key value pairs used by the SDK to perform a successful initiate

Refer to the following table for information about the description and sample payload.

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example:- $requestId

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

Value: initiate

                      merchantId
                      *
                      

String

Mandatory

Unique merchant id shared during onboarding

                      clientId
                      *
                      

String

Mandatory

Unique Client id shared during onboarding

                      environment
                      *
                      

String

Mandatory

Environment to be used for the session. Accepted value is “production” / “sandbox“.

Step 4

Call initiate

The final step is to call the Initiate SDK API.

The initiate method takes two parameters: InitiatePayload and HyperPaymentsCallbackAdapter. Use the functions created in the above steps to create the parameters

Initiate is a fire-and-forget call. For every HyperService instance you should call initiate only once.