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

Get Session Token

This action helps provide user’s current state and is used to maintain app session .

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 (SMS, Phone).
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.

REGISTERED - When there is no account linked to a vpa , will usually get it for UPI Circle .

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

                      signature
                      *
                      

String

Mandatory

Base 64 encoding of signaturePayload and Protected .

                      protected
                      *
                      

String

Mandatory

Base 64 encoding of the below parameters.

                      kid
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.It will be provided to you by the Juspay team.

Example: uat833359804655bb748702e324111

                      Alg
                      *
                      

String

Mandatory

Asymmetric algorithm used. Will be RS256 in this case..

Example:- RS256

                      signaturePayload
                      *
                      

String

Mandatory

Base 64 encoded stringified signature payload

                      merchantId
                      *
                      

String

Mandatory

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

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for the customer.

                      merchantChannelId
                      *
                      

String

Mandatory

As provided by Juspay.

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.