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

Get Session Token

It should not be called on an HyperSDK instance which has not been initiated. To verify if an instance is initiated, kindly refer to check SDK initiated in code.

Process Parameters

Status Description

NOPERMISSION - User has not given necessary permissions yet (Phone State).
FRESH - Necessary permissions are provided but the user is not registered.
BOUND - User registered on device but no accounts are found.
LINKED - User registered on device and valid accounts are found.

Request

Response

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

Operation to be performed in the SDK.

Example:- upiGetSessionToken

                      merchantKeyId
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload

                      signaturePayload
                      *
                      

String

Mandatory

Signature payload is a stringified JSON of the details mentioned in the below table.

                      merchant_id
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.Ex: stock

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

                      customerMobileNumber
                      
                      

String

optional

Mobile number of the customer

Example:-

                      simId
                      
                      

String

optional

ID for sim

Example:- 0/1/2, etc

                      udfParameters
                      
                      

JSON string

optional

Stringified JSON for udf parameters