--- page_title: Get Session Token product: UPI TPAP SDK platform: Android page_source: https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/get-session-token llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt --- ## 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 > **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 - **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 - Tags: String, Mandatory - **CustomerMobileNumber**: - Description: Mobile number of the customer - Value: - Tags: String, optional - **SimId**: - Description: ID for sim - Value: 0/1/2, etc - Tags: String, optional - **UdfParameters**: - Description: Stringified JSON for udf parameters - Tags: JSON 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, Mandatory - **Status**: - Description: Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED. - Tags: String, Mandatory - **IsDeviceBound**: - Description: If the current device is in bound state or not. - Value: Possible values: true/false - Tags: String, Mandatory - **IsDeviceActivated**: - Description: If the device is in active state or not - Value: Possible values: true/false - Tags: String, Mandatory - **Prefix**: - Description: Prefix to append before requestID - Value: Example: ABC - Tags: String, Mandatory - **VpaAccounts**: - Description: It's an array of Vpa Accounts. We will get this only after successful linking of accounts. - Value: - **Vpa**: - Description: Vpa - Value: abc@xyz - Tags: String, Mandatory - **Account**: - Description: Accounts linked to this vpa - Value: - **BankCode**: - Description: IIN Code for the bank - Tags: String, Mandatory - **BankName**: - Description: Name of bank - Tags: String, Mandatory - **MaskedAccountNumber**: - Description: Account Number with last few digits visible - Tags: String, Mandatory - **MpinLength**: - Description: Length of mpin - Tags: String, Mandatory - **MpinSet**: - Description: Is mpin set? - Value: Possible values: true/false - Tags: String, Mandatory - **ReferenceId**: - Description: Account Reference Id. Incase of lite account, this would be in the format of || - Value: Example: A0760cb548bb4dda9d32e3030863dd5. Example incase of lite account : A0760cb548bb4dda9d32e3030863dd5||01002600010235200170091493868500398 - Tags: String, Mandatory - **OtpLength**: - Description: Length of OTP - Value: Example: 6 - Tags: String, Mandatory - **AtmPinLength**: - Description: Length of atm pin - Value: Example: 6 - Tags: String, Mandatory - **Type**: - Description: Type of account. Incase of lite account, the type of the account would be appended with ||LITE - Value: Example: Savings. Example incase lite account, CURRENT||LITE - Tags: String, Optional - **BranchName**: - Description: Name of branch in which account is registered - Tags: String, Optional - **BankAccountUniqueId**: - Description: Unique Identifier for bank account across banks - Tags: String, Optional - **Ifsc**: - Description: Account IFSC - Tags: String, Optional - **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, Optional - **Name**: - Description: Name of account holder - Value: Example: ABC - Tags: String, Optional - Tags: Array of JSON, Mandatory - Tags: Array of JSON, Optional - **CustomerMobileNumber**: - Description: Masked phone number of the customer - Value: - Tags: String, Optional - **DeviceFingerPrint**: - Description: Unique fingerprint of the device - Tags: String, Optional - **OtherInfo**: - Description: As passed in request - Tags: String, Optional - **UpiNumbers**: - Description: Upi Numbers - Value: - **UpiNumberStatus**: - Description: The status of the upiNumber. - Value: Active,Deleted - Tags: String, Mandatory - **UpiNumber**: - Description: The upi Number - Value: - Tags: String, Mandatory - **Vpa**: - Description: vpa - Value: abc@xyz - Tags: String, Mandatory - **Expiry**: - Tags: String, optional - Tags: array of Strings, Optional - **AllowedAccountTypes**: - Tags: Array String, Optional - **UdfParameters**: - Description: Stringified JSON for udf parameters - Tags: JSON string, Optional - 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 { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } ``` #### Kotlin Code Snippet: ```kotlin { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } ``` ## Sample Code Snippets: ### Request snippets: #### Request Code Snippet: ```request // block:start:checkPermissionReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckPermission" } } // block:end:checkPermissionReqH // block:start:checkPermissionRespH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckPermission", "status": "DENIED" / "GRANTED", "permissions": [ "0": { "status": "GRANTED", "label": "android.permission.SEND_SMS" } "1": { "status": "GRANTED", "label": "android.permission.READ_PHONE_STATE" } "2": { "status": "GRANTED", "label": "android.permission.RECEIVE_SMS" } ] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:checkPermissionRespH // block:start:getPermissionReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetPermission" } } // block:end:getPermissionReqH // block:start:getPermissionRespH { "errorMessage": "", "requestId": "", "service": "in.juspay.inappupi", "payload": { "permissions": [ { "label": "android.permission.SEND_SMS", "status": "GRANTED / DENIED" }, { "label": "android.permission.READ_PHONE_STATE", "status": "GRANTED / DENIED"" }, { "label": "android.permission.RECEIVE_SMS", "status": "GRANTED / DENIED"" }, { "label": "android.permission.READ_SMS", "status": "GRANTED / DENIED"" } ], "status": "SUCCESS / FAILURE", "action": "upiGetPermission" }, "errorCode": "", "event": "process_result", "error": false } // block:end:getPermissionRespH // block:start:sessionTokenReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:sessionTokenReqH // block:start:sessionTokenRespH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "status": "LINKED", "isDeviceBound": "true", "isDeviceActivated": "true", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "bankAccountUniqueId": "ABCD123", "isPrimary": "true", "isInitialTopUpDone": "true", //In case of UPI lite "otpLength": "6", "atmPinLength": "6", "type": "SAVINGS", "branchName": "ABC", "ifsc": "AABC1000000", "name": "Venkat", "supportedFeatures": { "recurrenceMandate": true, "upiCredit": false, "aadhaar": true, "fir": true, "emi": false, "liteOffline": false, "base": true, "bioAuth": true, "nfs": false, "global": false, "ccBill": true, "clDynamicKeys": false, "voucherManagementSystem": false, "credit": false, "mandate": true, "lite": false }, }, "vpa": "abc@xyz" }], "prefix": "XYZ", "customerMobileNumber": "XXXXXX7777", "deviceFingerPrint": "d925f3dbcfac" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:sessionTokenRespH // block:start:getSimDetailsReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSimDetails", } } // block:end:getSimDetailsReqH // block:start:getSimDetailsRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSimDetails", "status": "SUCCESS/FAILURE", "simDetails": [ { "id": "< id >", "provider": "< provider >", "simSerialNo": "< simSerialNo >" }, { "id": "< id >", "provider": "< provider >", "simSerialNo": "< simSerialNo >" } ] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:getSimDetailsRespH // block:start:bindActivateDeviceReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiBindActivateDevice", "simId": "", "customerMobileNumber": "9876543210", "isBindAndActivateRequest": true, "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "1234567", "timestamp": "234562345" } // block:end:bindActivateDeviceReqH // block:start:bindActivateDeviceRespH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiBindActivateDevice", "status": "SUCCESS", "isDeviceBound": "true", "isDeviceActivated": "true", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "abc@xyz", }], "prefix": "XYZ" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:bindActivateDeviceRespH // block:start:getAccountsReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetAccounts", "bankCodes": ["code"], "aadhaarConsent":"true" } } // block:end:getAccountsReqH // block:start:getAccountsRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetAccounts", "status": "SUCCESS" / "FAILURE", "accounts": [ < list of accounts > ], "vpaSuggestions": [] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:getAccountsRespH // block:start:getBankListReq { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetBankList" } } // block:end:getBankListReq // block:start:getBankListResp { "service": "in.juspay.hyperapi", "requestId": "f62cf173-0da9-4d78-ba9e-4ad0f61dff40", "payload": { "status": "SUCCESS", "bankList": [ { "upiEnabled": "true", "name": "Mybank", "iin": "500002", "id": "A9a54e051d6341fa9754a931ed15208", "supported": { "recurrenceMandate": true, "mandate": true, "lite": true, "global": false, "fir": true, "credit": true, "base": true }, }, { "upiEnabled": "true", "name": "YesBank", "iin": "612346", "id": "Ad250241cc00425fa58df480230f0c0", "supported": { "recurrenceMandate": true, "mandate": true, "lite": true, "global": false, "fir": true, "credit": true, "base": true }, }, { "upiEnabled": "true", "name": "Mybank-Yes", "iin": "500007", "id": "Ad250241cc00425fa58df480230f0c0", "supported": { "recurrenceMandate": true, "mandate": true, "lite": true, "global": false, "fir": true, "credit": true, "base": true }, }, ... ], "action": "upiGetBankList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:getBankListResp // block:start:vpaAvailableReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiVpaAvailability", "customerVpa": "something@handle" } } // block:end:vpaAvailableReqH // block:start:vpaAvailableRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiVpaAvailability", "status": "SUCCESS" / "FAILURE", "available": "true" / "false", "vpaSuggestions": [] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:vpaAvailableRespH // block:start:linkAccountsReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiLinkAccounts", "customerVpa": "something@handle", "accountReferenceIds": ["acc1", "acc2"] } } // block:end:linkAccountsReqH // block:start:linkAccountsRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiLinkAccounts", "status": "SUCCESS" / "FAILURE", "customerMobileNumber": "XXXX7890", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "abc@xyz" }], "gatewayResponseCode": "", "gatewayResponseMessage": "", "defaultAccountReferenceId":"A0760cb548bb4dda9d32e3030863dd5" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:linkAccountsRespH // block:start:setMpinDebitReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiSetMpin", "customerVpa": "something@handle", "upiRequestId": "", "accountReferenceId": "", "card": "123456", "expiry": "MMYY", "getCardDetailsInCL":"true" } } // block:end:setMpinDebitReqH // block:start:setMpinAadhaarReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiSetMpin", "customerVpa": "something@handle", "upiRequestId": "", "accountReferenceId": "", "aadhaarNo":"111122", "aadhaarConsent":"true", "getCardDetailsInCL":"true" } } // block:end:setMpinAadhaarReqH ``` ### Response snippets: #### Response: ```plaintext // block:start:checkPermissionReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckPermission" } } // block:end:checkPermissionReqH // block:start:checkPermissionRespH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckPermission", "status": "DENIED" / "GRANTED", "permissions": [ "0": { "status": "GRANTED", "label": "android.permission.SEND_SMS" } "1": { "status": "GRANTED", "label": "android.permission.READ_PHONE_STATE" } "2": { "status": "GRANTED", "label": "android.permission.RECEIVE_SMS" } ] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:checkPermissionRespH // block:start:getPermissionReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetPermission" } } // block:end:getPermissionReqH // block:start:getPermissionRespH { "errorMessage": "", "requestId": "", "service": "in.juspay.inappupi", "payload": { "permissions": [ { "label": "android.permission.SEND_SMS", "status": "GRANTED / DENIED" }, { "label": "android.permission.READ_PHONE_STATE", "status": "GRANTED / DENIED"" }, { "label": "android.permission.RECEIVE_SMS", "status": "GRANTED / DENIED"" }, { "label": "android.permission.READ_SMS", "status": "GRANTED / DENIED"" } ], "status": "SUCCESS / FAILURE", "action": "upiGetPermission" }, "errorCode": "", "event": "process_result", "error": false } // block:end:getPermissionRespH // block:start:sessionTokenReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:sessionTokenReqH // block:start:sessionTokenRespH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "status": "LINKED", "isDeviceBound": "true", "isDeviceActivated": "true", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "bankAccountUniqueId": "ABCD123", "isPrimary": "true", "isInitialTopUpDone": "true", //In case of UPI lite "otpLength": "6", "atmPinLength": "6", "type": "SAVINGS", "branchName": "ABC", "ifsc": "AABC1000000", "name": "Venkat", "supportedFeatures": { "recurrenceMandate": true, "upiCredit": false, "aadhaar": true, "fir": true, "emi": false, "liteOffline": false, "base": true, "bioAuth": true, "nfs": false, "global": false, "ccBill": true, "clDynamicKeys": false, "voucherManagementSystem": false, "credit": false, "mandate": true, "lite": false }, }, "vpa": "abc@xyz" }], "prefix": "XYZ", "customerMobileNumber": "XXXXXX7777", "deviceFingerPrint": "d925f3dbcfac" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:sessionTokenRespH // block:start:getSimDetailsReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSimDetails", } } // block:end:getSimDetailsReqH // block:start:getSimDetailsRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSimDetails", "status": "SUCCESS/FAILURE", "simDetails": [ { "id": "< id >", "provider": "< provider >", "simSerialNo": "< simSerialNo >" }, { "id": "< id >", "provider": "< provider >", "simSerialNo": "< simSerialNo >" } ] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:getSimDetailsRespH // block:start:bindActivateDeviceReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiBindActivateDevice", "simId": "", "customerMobileNumber": "9876543210", "isBindAndActivateRequest": true, "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "1234567", "timestamp": "234562345" } // block:end:bindActivateDeviceReqH // block:start:bindActivateDeviceRespH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiBindActivateDevice", "status": "SUCCESS", "isDeviceBound": "true", "isDeviceActivated": "true", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "abc@xyz", }], "prefix": "XYZ" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:bindActivateDeviceRespH // block:start:getAccountsReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetAccounts", "bankCodes": ["code"], "aadhaarConsent":"true" } } // block:end:getAccountsReqH // block:start:getAccountsRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetAccounts", "status": "SUCCESS" / "FAILURE", "accounts": [ < list of accounts > ], "vpaSuggestions": [] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:getAccountsRespH // block:start:getBankListReq { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetBankList" } } // block:end:getBankListReq // block:start:getBankListResp { "service": "in.juspay.hyperapi", "requestId": "f62cf173-0da9-4d78-ba9e-4ad0f61dff40", "payload": { "status": "SUCCESS", "bankList": [ { "upiEnabled": "true", "name": "Mybank", "iin": "500002", "id": "A9a54e051d6341fa9754a931ed15208", "supported": { "recurrenceMandate": true, "mandate": true, "lite": true, "global": false, "fir": true, "credit": true, "base": true }, }, { "upiEnabled": "true", "name": "YesBank", "iin": "612346", "id": "Ad250241cc00425fa58df480230f0c0", "supported": { "recurrenceMandate": true, "mandate": true, "lite": true, "global": false, "fir": true, "credit": true, "base": true }, }, { "upiEnabled": "true", "name": "Mybank-Yes", "iin": "500007", "id": "Ad250241cc00425fa58df480230f0c0", "supported": { "recurrenceMandate": true, "mandate": true, "lite": true, "global": false, "fir": true, "credit": true, "base": true }, }, ... ], "action": "upiGetBankList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:getBankListResp // block:start:vpaAvailableReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiVpaAvailability", "customerVpa": "something@handle" } } // block:end:vpaAvailableReqH // block:start:vpaAvailableRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiVpaAvailability", "status": "SUCCESS" / "FAILURE", "available": "true" / "false", "vpaSuggestions": [] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:vpaAvailableRespH // block:start:linkAccountsReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiLinkAccounts", "customerVpa": "something@handle", "accountReferenceIds": ["acc1", "acc2"] } } // block:end:linkAccountsReqH // block:start:linkAccountsRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiLinkAccounts", "status": "SUCCESS" / "FAILURE", "customerMobileNumber": "XXXX7890", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "abc@xyz" }], "gatewayResponseCode": "", "gatewayResponseMessage": "", "defaultAccountReferenceId":"A0760cb548bb4dda9d32e3030863dd5" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:linkAccountsRespH // block:start:setMpinDebitReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiSetMpin", "customerVpa": "something@handle", "upiRequestId": "", "accountReferenceId": "", "card": "123456", "expiry": "MMYY", "getCardDetailsInCL":"true" } } // block:end:setMpinDebitReqH // block:start:setMpinAadhaarReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiSetMpin", "customerVpa": "something@handle", "upiRequestId": "", "accountReferenceId": "", "aadhaarNo":"111122", "aadhaarConsent":"true", "getCardDetailsInCL":"true" } } // block:end:setMpinAadhaarReqH ``` --- ## Complete Code Reference The following code files are referenced in the steps above: ### InappHeadless.txt ``` // block:start:checkPermissionReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckPermission" } } // block:end:checkPermissionReqH // block:start:checkPermissionRespH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckPermission", "status": "DENIED" / "GRANTED", "permissions": [ "0": { "status": "GRANTED", "label": "android.permission.SEND_SMS" } "1": { "status": "GRANTED", "label": "android.permission.READ_PHONE_STATE" } "2": { "status": "GRANTED", "label": "android.permission.RECEIVE_SMS" } ] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:checkPermissionRespH // block:start:getPermissionReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetPermission" } } // block:end:getPermissionReqH // block:start:getPermissionRespH { "errorMessage": "", "requestId": "", "service": "in.juspay.inappupi", "payload": { "permissions": [ { "label": "android.permission.SEND_SMS", "status": "GRANTED / DENIED" }, { "label": "android.permission.READ_PHONE_STATE", "status": "GRANTED / DENIED"" }, { "label": "android.permission.RECEIVE_SMS", "status": "GRANTED / DENIED"" }, { "label": "android.permission.READ_SMS", "status": "GRANTED / DENIED"" } ], "status": "SUCCESS / FAILURE", "action": "upiGetPermission" }, "errorCode": "", "event": "process_result", "error": false } // block:end:getPermissionRespH // block:start:sessionTokenReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:sessionTokenReqH // block:start:sessionTokenRespH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "status": "LINKED", "isDeviceBound": "true", "isDeviceActivated": "true", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "bankAccountUniqueId": "ABCD123", "isPrimary": "true", "isInitialTopUpDone": "true", //In case of UPI lite "otpLength": "6", "atmPinLength": "6", "type": "SAVINGS", "branchName": "ABC", "ifsc": "AABC1000000", "name": "Venkat", "supportedFeatures": { "recurrenceMandate": true, "upiCredit": false, "aadhaar": true, "fir": true, "emi": false, "liteOffline": false, "base": true, "bioAuth": true, "nfs": false, "global": false, "ccBill": true, "clDynamicKeys": false, "voucherManagementSystem": false, "credit": false, "mandate": true, "lite": false }, }, "vpa": "abc@xyz" }], "prefix": "XYZ", "customerMobileNumber": "XXXXXX7777", "deviceFingerPrint": "d925f3dbcfac" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:sessionTokenRespH // block:start:getSimDetailsReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSimDetails", } } // block:end:getSimDetailsReqH // block:start:getSimDetailsRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSimDetails", "status": "SUCCESS/FAILURE", "simDetails": [ { "id": "< id >", "provider": "< provider >", "simSerialNo": "< simSerialNo >" }, { "id": "< id >", "provider": "< provider >", "simSerialNo": "< simSerialNo >" } ] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:getSimDetailsRespH // block:start:bindActivateDeviceReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiBindActivateDevice", "simId": "", "customerMobileNumber": "9876543210", "isBindAndActivateRequest": true, "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "1234567", "timestamp": "234562345" } // block:end:bindActivateDeviceReqH // block:start:bindActivateDeviceRespH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiBindActivateDevice", "status": "SUCCESS", "isDeviceBound": "true", "isDeviceActivated": "true", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "abc@xyz", }], "prefix": "XYZ" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:bindActivateDeviceRespH // block:start:getAccountsReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetAccounts", "bankCodes": ["code"], "aadhaarConsent":"true" } } // block:end:getAccountsReqH // block:start:getAccountsRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetAccounts", "status": "SUCCESS" / "FAILURE", "accounts": [ < list of accounts > ], "vpaSuggestions": [] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:getAccountsRespH // block:start:getBankListReq { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetBankList" } } // block:end:getBankListReq // block:start:getBankListResp { "service": "in.juspay.hyperapi", "requestId": "f62cf173-0da9-4d78-ba9e-4ad0f61dff40", "payload": { "status": "SUCCESS", "bankList": [ { "upiEnabled": "true", "name": "Mybank", "iin": "500002", "id": "A9a54e051d6341fa9754a931ed15208", "supported": { "recurrenceMandate": true, "mandate": true, "lite": true, "global": false, "fir": true, "credit": true, "base": true }, }, { "upiEnabled": "true", "name": "YesBank", "iin": "612346", "id": "Ad250241cc00425fa58df480230f0c0", "supported": { "recurrenceMandate": true, "mandate": true, "lite": true, "global": false, "fir": true, "credit": true, "base": true }, }, { "upiEnabled": "true", "name": "Mybank-Yes", "iin": "500007", "id": "Ad250241cc00425fa58df480230f0c0", "supported": { "recurrenceMandate": true, "mandate": true, "lite": true, "global": false, "fir": true, "credit": true, "base": true }, }, ... ], "action": "upiGetBankList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:getBankListResp // block:start:vpaAvailableReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiVpaAvailability", "customerVpa": "something@handle" } } // block:end:vpaAvailableReqH // block:start:vpaAvailableRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiVpaAvailability", "status": "SUCCESS" / "FAILURE", "available": "true" / "false", "vpaSuggestions": [] }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:vpaAvailableRespH // block:start:linkAccountsReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiLinkAccounts", "customerVpa": "something@handle", "accountReferenceIds": ["acc1", "acc2"] } } // block:end:linkAccountsReqH // block:start:linkAccountsRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiLinkAccounts", "status": "SUCCESS" / "FAILURE", "customerMobileNumber": "XXXX7890", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "abc@xyz" }], "gatewayResponseCode": "", "gatewayResponseMessage": "", "defaultAccountReferenceId":"A0760cb548bb4dda9d32e3030863dd5" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:linkAccountsRespH // block:start:setMpinDebitReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiSetMpin", "customerVpa": "something@handle", "upiRequestId": "", "accountReferenceId": "", "card": "123456", "expiry": "MMYY", "getCardDetailsInCL":"true" } } // block:end:setMpinDebitReqH // block:start:setMpinAadhaarReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiSetMpin", "customerVpa": "something@handle", "upiRequestId": "", "accountReferenceId": "", "aadhaarNo":"111122", "aadhaarConsent":"true", "getCardDetailsInCL":"true" } } // block:end:setMpinAadhaarReqH ``` --- ## See Also - [UI Direct Links](https://juspay.io/in/docs/upi-tpap-sdk/android/ui-process-payloads/direct-links) - [Check Permission](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/check-permission)