Get Session Token
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.
To be sent for express onboarding and cred offers flow usecase
Example:- 12 digits mobile number
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.
12 digit mobile number to be passed (with 91 prefix). To be passed when issuing PSP is BHIM or when device binding has to be limited to a particular mobile number.
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.
UPI ID linked to account
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
Length of OTP
Example: 6
Length of atm pin
Example: 6
Type of account
Example: Savings
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.
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
Possible values :- true/false
Error Message
Error Code
Value: process_result
Unique uuid-v4 string
Example:- $requestId
Value: in.juspay.hyperapi
Parameters required to call Hyper SDK API
Operation performed in the SDK.
Example:- upiGetSessionToken
Unique identifier associated with an account created by juspay.
Example: stock
Any unique reference associated with your customer.
Example: abcde12345
clientAuthToken
Example: tkn_2p2k1b6d26eg4740b9ef01294d3a43b4
Default 15min (functionality to be extended if configuration to change signature expiry is added)
Example: 2021-07-19T07:20:53.318Z
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.
UPI ID linked to account
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
Length of OTP
Example: 6
Length of atm pin
Example: 6
Type of account
Example: Savings
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.
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
Possible values :- true/false
Error Message
Error Code
Value: process_result
Have questions?
- Need help? Contact support
- LLM? Read llms.txt