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.
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.
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
Value: in.juspay.hyperapi
Parameters required to call Hyper SDK API
Operation to be performed in the SDK.
Example:- upiGetSessionToken
Key ID to identify the public-private key pair used for signature generation.
Signature generated for the signaturePayload
Signature payload is a stringified JSON of the details mentioned in the below table.
Unique identifier associated with an account created by juspay.Ex: stock
Any unique reference associated with your customer.
Time when request is created in milliseconds.
Mobile number of the customer
Example:-
ID for sim
Example:- 0/1/2, etc
Stringified JSON for udf parameters
Unique uuid-v4 string
Example: abcd-12345-abcd-12345
Value: in.juspay.hyperapi
Response Parameters
Operation performed in the SDK.
Example:- upiGetSessionToken
Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED.
If the current device is in bound state or not.
Example:- Possible values: true/false
If the device is in active state or not
Example:- Possible values: true/false
Prefix to append before requestID
Example: ABC
It's an array of Vpa Accounts. We will get this only after successful linking of accounts.
Vpa
Example:- abc@xyz
Accounts linked to this vpa
IIN Code for the bank
Name of bank
Account Number with last few digits visible
Length of mpin
Is mpin set?
Example:- Possible values: true/false
Account Reference Id. Incase of lite account, this would be in the format of <accRefID>||<LRN>
Example: A0760cb548bb4dda9d32e3030863dd5. Example incase of lite account : A0760cb548bb4dda9d32e3030863dd5||01002600010235200170091493868500398
Length of OTP
Example: 6
Length of atm pin
Example: 6
Type of account. Incase of lite account, the type of the account would be appended with ||LITE
Example: Savings. Example incase lite account, CURRENT||LITE
Name of branch in which account is registered
Unique Identifier for bank account across banks
Account IFSC
This key will be available in UPI Lite usecase. The value of this either be 'true' or 'topup_txn_pending', the occurence of 'topup_txn_pending' will be very rare and its state will get updated in every 10mins.
Example:- Possible values: true/topup_txn_pending
Is this account the primary account
Example:- Possible values: true/false
Name of account holder
Example: ABC
Masked phone number of the customer
Example:-
Unique fingerprint of the device
As passed in request
Upi Numbers
The status of the upiNumber.
Example:- Active,Deleted
The upi Number
Example:-
vpa
Example:- abc@xyz
Stringified JSON for udf parameters
Possible values :- true/false
Error Message
Error Code
Value: process_result