--- page_source: https://juspay.io/in/docs/upi-plugin-sdk/cordova/miscellaneous/get-session-token page_title: Get Session Token --- # Get Session Token ### Process Parameters - Signature Support > **Note** > 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 Payload - **RequestId**: - Description: Unique uuid-v4 string. - Value: Example: abcd-12345-abcd-12345 - Tags: String, Mandatory - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String, Mandatory - **Payload**: - Description: Parameters required to call Hyper SDK API - Value: - **Action**: - Description: Operation to be performed in the SDK. - Value: upiGetSessionToken - Tags: String, Mandatory - **MerchantKeyId**: - Description: Key ID to identify the public-private key pair used for signature generation. - Tags: String, Mandatory - **CustomerMobileNumber**: - Description: To be sent for express onboarding and cred offers flow usecase - Value: 12 digits mobile number - Tags: String, Conditional - **Signature**: - Description: Signature generated for the signaturePayload - Tags: String, Mandatory - **SignaturePayload**: - Description: Signature payload is a stringified JSON of the details mentioned in the below table. - Value: - **Merchant_id**: - Description: Unique identifier associated with an account created by juspay.Ex: stock - Tags: String, Mandatory - **Customer_id**: - Description: Any unique reference associated with your customer. - Tags: String, Mandatory - **Timestamp**: - Description: Time when request is created in milliseconds. - Tags: String, Mandatory - **Customer_mobile_number**: - Description: 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. - Tags: String, Conditional - Tags: String, Mandatory - Tags: JSON, Mandatory ## Response Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: Example: abcd-12345-abcd-12345 - Tags: String - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String - **Payload**: - Description: Response Parameters - Value: - **Action**: - Description: Operation performed in the SDK. - Value: upiGetSessionToken - Tags: String - **Status**: - Description: Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED. - Tags: String - **IsDeviceBound**: - Description: If the current device is in bound state or not. - Value: Possible values: true/false - Tags: String - **IsDeviceActivated**: - Description: If the device is in active state or not - Value: Possible values: true/false - Tags: String - **Prefix**: - Description: Prefix to append before requestID - Value: Example: ABC - Tags: String - **VpaAccounts**: - Description: It's an array of Vpa Accounts. We will get this only after successful linking of accounts. - Value: - **Vpa**: - Description: UPI ID linked to account - Tags: String - **Accounts**: - Description: Accounts linked to this vpa - Value: - **BankCode**: - Description: IIN Code for the bank - Tags: String - **BankName**: - Description: Name of bank - Tags: String - **MaskedAccountNumber**: - Description: Account Number with last few digits visible - Tags: String - **MpinLength**: - Description: Length of mpin - Tags: String - **MpinSet**: - Description: Is mpin set? - Value: Possible values: true/false - Tags: String - **ReferenceId**: - Description: Account Reference Id - Tags: String - **OtpLength**: - Description: Length of OTP - Value: Example: 6 - Tags: String - **AtmPinLength**: - Description: Length of atm pin - Value: Example: 6 - Tags: String - **Type**: - Description: Type of account - Value: Example: Savings - Tags: String - **BranchName**: - Description: Name of branch in which account is registered - Tags: String - **BankAccountUniqueId**: - Description: Unique Identifier for bank account across banks - Tags: String - **Ifsc**: - Description: Account IFSC - Tags: String - **IsInitialTopUpDone**: - Description: 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. - Value: Possible values: true/topup_txn_pending - Tags: Conditional - **IsPrimary**: - Description: Is this account the primary account - Value: Possible values: true/false - Tags: String - **Name**: - Description: Name of account holder - Value: Example: ABC - Tags: String - Tags: Array of JSON - Tags: Array of JSON - **CustomerMobileNumber**: - Description: Masked phone number of the customer - Value: - Tags: String - **DeviceFingerPrint**: - Description: Unique fingerprint of the device - Tags: String - **OtherInfo**: - Description: As passed in request - Tags: String - Tags: JSON - **Error**: - Description: Possible values :- true/false - Tags: Boolean - **ErrorMessage**: - Description: Error Message - Tags: String - **ErrorCode**: - Description: Error Code - Tags: String - **Event**: - Description: Value: process_result - Tags: String #### Code Snippets: - #### Java Code Snippet: ```java {"success":false,"message":"No Data found for the given path"} ``` #### Kotlin Code Snippet: ```kotlin {"success":false,"message":"No Data found for the given path"} ``` ### Process Parameters - ClientAuthToken Support ## Request Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: $requestId - Tags: String, Mandatory - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String, Mandatory - **Payload**: - Description: Parameters required to call Hyper SDK API - Value: - **Action**: - Description: Operation performed in the SDK. - Value: upiGetSessionToken - Tags: String - **MerchantId**: - Description: Unique identifier associated with an account created by juspay. - Value: Example: stock - Tags: String, Mandatory - **CustomerId**: - Description: Any unique reference associated with your customer. - Value: Example: abcde12345 - Tags: String, Mandatory - **ClientAuthToken**: - Description: clientAuthToken - Value: Example: tkn_2p2k1b6d26eg4740b9ef01294d3a43b4 - Tags: String, Mandatory - **AuthExpiry**: - Description: Default 15min (functionality to be extended if configuration to change signature expiry is added) - Value: Example: 2021-07-19T07:20:53.318Z - Tags: String, Optional - Tags: JSON, Mandatory ## Response Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: Example: abcd-12345-abcd-12345 - Tags: String - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String - **Payload**: - Description: Response Parameters - Value: - **Action**: - Description: Operation performed in the SDK. - Value: upiGetSessionToken - Tags: String - **Status**: - Description: Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED. - Tags: String - **IsDeviceBound**: - Description: If the current device is in bound state or not. - Value: Possible values: true/false - Tags: String - **IsDeviceActivated**: - Description: If the device is in active state or not - Value: Possible values: true/false - Tags: String - **Prefix**: - Description: Prefix to append before requestID - Value: Example: ABC - Tags: String - **VpaAccounts**: - Description: It's an array of Vpa Accounts. We will get this only after successful linking of accounts. - Value: - **Vpa**: - Description: UPI ID linked to account - Tags: String - **Accounts**: - Description: Accounts linked to this vpa - Value: - **BankCode**: - Description: IIN Code for the bank - Tags: String - **BankName**: - Description: Name of bank - Tags: String - **MaskedAccountNumber**: - Description: Account Number with last few digits visible - Tags: String - **MpinLength**: - Description: Length of mpin - Tags: String - **MpinSet**: - Description: Is mpin set? - Value: Possible values: true/false - Tags: String - **ReferenceId**: - Description: Account Reference Id - Tags: String - **OtpLength**: - Description: Length of OTP - Value: Example: 6 - Tags: String - **AtmPinLength**: - Description: Length of atm pin - Value: Example: 6 - Tags: String - **Type**: - Description: Type of account - Value: Example: Savings - Tags: String - **BranchName**: - Description: Name of branch in which account is registered - Tags: String - **BankAccountUniqueId**: - Description: Unique Identifier for bank account across banks - Tags: String - **Ifsc**: - Description: Account IFSC - Tags: String - **IsInitialTopUpDone**: - Description: 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. - Value: Possible values: true/topup_txn_pending - Tags: Conditional - **IsPrimary**: - Description: Is this account the primary account - Value: Possible values: true/false - Tags: String - **Name**: - Description: Name of account holder - Value: Example: ABC - Tags: String - Tags: Array of JSON - Tags: Array of JSON - **CustomerMobileNumber**: - Description: Masked phone number of the customer - Value: - Tags: String - **DeviceFingerPrint**: - Description: Unique fingerprint of the device - Tags: String - **OtherInfo**: - Description: As passed in request - Tags: String - Tags: JSON - **Error**: - Description: Possible values :- true/false - Tags: Boolean - **ErrorMessage**: - Description: Error Message - Tags: String - **ErrorCode**: - Description: Error Code - Tags: String - **Event**: - Description: Value: process_result - Tags: String #### Code Snippets: - #### Java Code Snippet: ```java {"success":false,"message":"No Data found for the given path"} ``` #### Kotlin Code Snippet: ```kotlin {"success":false,"message":"No Data found for the given path"} ```