--- page_title: UPI Get Bank List product: UPI TPAP SDK platform: Android page_source: https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/upi-get-bank-list llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt --- ## UPI Get Bank List ### Process Parameters ## 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. Should be getBankList for this call. - Value: Value: upiGetBankList - 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: Value: upiGetBankList - Tags: String - **Status**: - Description: Status of the Operation. Possible values : SUCCESS/FAILURE - Value: Example: SUCCESS - Tags: String - **BankList**: - Description: List of all UPI Banks - Value: - **UpiEnabled**: - Description: Is UPI enabled? - Value: Value: true/false - Tags: String, Mandatory - **Name**: - Description: Name of the Bank - Value: Example: YES bank - Tags: String, Mandatory - **Iin**: - Description: IIN code for the bank - Value: Value: 123456 - Tags: String, Mandatory - **Ifsc**: - Description: IFSC code - Value: Example: ABCD0123456 - Tags: String, Mandatory - **Id**: - Description: Unique Identifier for the account - Value: Example: abcd1234xyz - Tags: String, Mandatory - **Supported**: - Value: - **RecurrenceMandate**: - Value: values - True/False - Tags: Boolean, Optional - **UpiCredit**: - Value: values - True/False - Tags: Boolean, Optional - **Aadhaar**: - Value: values - True/False - Tags: Boolean, Optional - **Fir**: - Value: values - True/False - Tags: Boolean, Optional - **Emi**: - Value: values - True/False - Tags: Boolean, Optional - **LiteOffline**: - Value: values - True/False - Tags: Boolean, Optional - **Base**: - Value: values - True/False - Tags: Boolean, Optional - **Nfs**: - Value: values - True/False - Tags: Boolean, optional - **Global**: - Value: values - True/False - Tags: Boolean, Optional - **CcBill**: - Value: values - True/False - Tags: Boolean, Optional - **ClDynamicKeys**: - Value: values - True/False - Tags: Boolean, Optional - **VoucherManagementSystem**: - Value: values - True/False - Tags: Boolean, Optional - **Credit**: - Value: values - True/False - Tags: Boolean, Optional - **Mandate**: - Value: values - True/False - Tags: Boolean, Optional - **Lite**: - Value: values - True/False - Tags: Boolean, Optional - Tags: String, Mandatory - Tags: Array of JSON - Tags: JSON, Mandatory - **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 // block:start:getSessionTokenReq { "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:getSessionTokenReq // block:start:getSessionTokenResp { "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", "isInitialTopUpDone": "true", //In case of UPI lite "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "abc@xyz" }], "prefix": "XYZ" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:getSessionTokenResp // block:start:onboardingReq { "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a", "service": "in.juspay.hyperapi", "payload": { "action": "onboarding", "merchantKeyId": "", "signature": "", "signaturePayload": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:onboardingReq // block:start:onboardingResp { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "onboarding", "status": "SUCCESS", "linkedAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "type": "SAVINGS", "ifsc": "ABCD0123456", "name": "ABC", "branchName": "Bengaluru" }, "vpa": "7834861582-gww@yesg" }] "selectedAccount": { "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "type": "SAVINGS", "ifsc": "ABCD0123456", "name": "ABC", "branchName": "Bengaluru" }, "vpa": "7834861582-gww@yesg" } "sessionTokenResponse": { "status": "LINKED", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true" }, "vpa": "7834861582-gww@yesg" }] } }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:onboardingResp // block:start:onboardingAndPayReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "merchantKeyId": "", "signature": "", "signaturePayload": "", "accountRefId": "", "showStatusScreen": "true", "udfParameters": "{}" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "metadata.:gateway_reference_id" : "ABC123", "order_id": "ABC1234567890" } // block:end:onboardingAndPayReq // block:start:onboardingAndPayResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "txnUuid": "mozoghi9Z6PsanCGWK1V", "selectedAccount": { "vpa": "XXXX", "account": { "ifsc": "ABCD0000011", "mpinSet": "true", "bankCode": "123456", "referenceId": "A621542c281c4a20b8faf0ee1cb75d", "maskedAccountNumber": "XXXXXXX20000", "isPrimary": "true", "bankName": "Mybank" } }, "orderId": "ABCDE12345", "status": "SUCCESS", "accountRefId": "A621542c281c4a20b8faf0ee1cb75d", "udfParameters": "{}" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:onboardingAndPayResp // block:start:payReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "accountRefId": "ABC123456789", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "metadata.:gateway_reference_id" :"ABC123", "order_id": "ABC1234567890" } // block:end:payReq // block:start:payResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "txnUuid": "moz3hjuAtiiQriCVFBn", "selectedAccount": { "vpa": "abc@xyz", "account": { "type": "SAVINGS", "referenceId": "A0387f9jkl54476183527acfaf9491", "otpLength": "6", "name": "XXXXat", "mpinSet": "true", "mpinLength": "6", "maskedAccountNumber": "XXXXXXX20000", "isPrimary": "true", "ifsc": "AAAA1236543", "branchName": "", "bankName": "MYPSP", "bankCode": "500001", "bankAccountUniqueId": "082eedaa58700e492179e97841584HJ8d39a4cff9275ef8ee9bc59f9186d3d68", "atmPinLength": "4" } }, "status": "SUCCESS" "orderId": "ABC1234567890" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:payResp // block:start:onboardingAndCreateMandateReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "shouldCreateMandate": true, "initiationMode": "13", "purpose": "76", "payType":"P2M_PAY", "bankCodes": "["550055", "551100"]", // Only in case of TPV "transactionReference": "111-CM-1122334456-brokerref", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "metadata.:gateway_reference_id": "ABC123", "order_id": "ABC1234567890", "metadata.YES_BIZ:mandate_name": "metadata.YES_BIZ:ABC", "options.create_mandate": "REQUIRED", "mandate.max_amount": "2000.00", "mandate.amount_rule": "FIXED", "mandate.frequency": "MONTHLY", "bankAccountHashes": "["fejgfvhef67t376", "gryiu349rewiufdhsy8934"]", //Only in case of TPV "mandate.start_date": "166674893389237", "mandate.end_date": "16667389373820323", "mandate.block_fund": "true", "mandate.payer_revocable: "false" } // block:end:onboardingAndCreateMandateReq // block:start:onboardingAndCreateMandateResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "status": "SUCCESS", "mandate": { "amount": "10.00", "amountRule": "EXACT", "blockFund": "false", "expiry": "2022-01-02T14:17:06+05:30", "gatewayMandateId": "YJPMe5c9711f1ede1f5524e2fadb48003aa0", "gatewayReferenceId": "806115044725", "gatewayResponseCode": "00", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseStatus": "SUCCESS", "initiatedBy": "PAYER", "mandateName": "Test Mandate", "mandateTimestamp": "2021-12-30T14:17:06+05:30", "merchantCustomerId": "DEMO-1234", "merchantRequestId": "eulb1a4418b4ac", "orgMandateId": "BJJMe5c9711f1ede1f5524e2f92648y03aa0", "payeeMcc": "4924", "payeeName": "GROWW", "payeeVpa": "growwuat@ypay", "payerName": "customer1", "payerRevocable": "true", "payerVpa": "customer1@ypay", "recurrencePattern": "WEEKLY", "recurrenceRule": "BEFORE", "recurrenceValue": "2", "refUrl": "https://www.google.com", "remarks": "Sample Remarks", "role": "PAYER", "shareToPayee": "true", "transactionType": "UPI_MANDATE", "umn": "uniqueMandateNumber@ypay", "validityEnd": "2022/09/20", "validityStart": "2022/01/20" } }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:onboardingAndCreateMandateResp // block:start:createMandateReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "shouldCreateMandate": true, "merchantKeyId": "", "signature": "", "signaturePayload": "", "accountRefId" : "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "metadata.:gateway_reference_id": "ABC123", "order_id": "ABC1234567890", "metadata.YES_BIZ:mandate_name": "metadata.YES_BIZ:ABC", "options.create_mandate": "REQUIRED", "mandate.max_amount": "2000.00", "mandate.amount_rule": "FIXED", "mandate.frequency": "MONTHLY", "mandate.start_date": "166674893389237", "mandate.end_date": "16667389373820323" } // block:end:createMandateReq // block:start:createMandateResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "status": "SUCCESS", "mandate": { "amount": "10.00", "amountRule": "EXACT", "blockFund": "false", "expiry": "2022-01-02T14:17:06+05:30", "gatewayMandateId": "YJPMe5c9711f1ede1f5524e2fadb48003aa0", "gatewayReferenceId": "806115044725", "gatewayResponseCode": "00", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseStatus": "SUCCESS", "initiatedBy": "PAYER", "mandateName": "Test Mandate", "mandateTimestamp": "2021-12-30T14:17:06+05:30", "merchantCustomerId": "DEMO-1234", "merchantRequestId": "eulb1a4418b4ac", "orgMandateId": "BJJMe5c9711f1ede1f5524e2f92648y03aa0", "payeeMcc": "4924", "payeeName": "GROWW", "payeeVpa": "growwuat@ypay", "payerName": "customer1", "payerRevocable": "true", "payerVpa": "customer1@ypay", "recurrencePattern": "WEEKLY", "recurrenceRule": "BEFORE", "recurrenceValue": "2", "refUrl": "https://www.google.com", "remarks": "Sample Remarks", "role": "PAYER", "shareToPayee": "true", "transactionType": "UPI_MANDATE", "umn": "uniqueMandateNumber@ypay", "validityEnd": "2022/09/20", "validityStart": "2022/01/20" } }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:createMandateResp ``` #### Kotlin Code Snippet: ```kotlin // block:start:getSessionTokenReq { "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:getSessionTokenReq // block:start:getSessionTokenResp { "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", "isInitialTopUpDone": "true", //In case of UPI lite "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "abc@xyz" }], "prefix": "XYZ" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:getSessionTokenResp // block:start:onboardingReq { "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a", "service": "in.juspay.hyperapi", "payload": { "action": "onboarding", "merchantKeyId": "", "signature": "", "signaturePayload": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:onboardingReq // block:start:onboardingResp { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "onboarding", "status": "SUCCESS", "linkedAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "type": "SAVINGS", "ifsc": "ABCD0123456", "name": "ABC", "branchName": "Bengaluru" }, "vpa": "7834861582-gww@yesg" }] "selectedAccount": { "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "type": "SAVINGS", "ifsc": "ABCD0123456", "name": "ABC", "branchName": "Bengaluru" }, "vpa": "7834861582-gww@yesg" } "sessionTokenResponse": { "status": "LINKED", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true" }, "vpa": "7834861582-gww@yesg" }] } }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:onboardingResp // block:start:onboardingAndPayReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "merchantKeyId": "", "signature": "", "signaturePayload": "", "accountRefId": "", "showStatusScreen": "true", "udfParameters": "{}" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "metadata.:gateway_reference_id" : "ABC123", "order_id": "ABC1234567890" } // block:end:onboardingAndPayReq // block:start:onboardingAndPayResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "txnUuid": "mozoghi9Z6PsanCGWK1V", "selectedAccount": { "vpa": "XXXX", "account": { "ifsc": "ABCD0000011", "mpinSet": "true", "bankCode": "123456", "referenceId": "A621542c281c4a20b8faf0ee1cb75d", "maskedAccountNumber": "XXXXXXX20000", "isPrimary": "true", "bankName": "Mybank" } }, "orderId": "ABCDE12345", "status": "SUCCESS", "accountRefId": "A621542c281c4a20b8faf0ee1cb75d", "udfParameters": "{}" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:onboardingAndPayResp // block:start:payReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "accountRefId": "ABC123456789", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "metadata.:gateway_reference_id" :"ABC123", "order_id": "ABC1234567890" } // block:end:payReq // block:start:payResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "txnUuid": "moz3hjuAtiiQriCVFBn", "selectedAccount": { "vpa": "abc@xyz", "account": { "type": "SAVINGS", "referenceId": "A0387f9jkl54476183527acfaf9491", "otpLength": "6", "name": "XXXXat", "mpinSet": "true", "mpinLength": "6", "maskedAccountNumber": "XXXXXXX20000", "isPrimary": "true", "ifsc": "AAAA1236543", "branchName": "", "bankName": "MYPSP", "bankCode": "500001", "bankAccountUniqueId": "082eedaa58700e492179e97841584HJ8d39a4cff9275ef8ee9bc59f9186d3d68", "atmPinLength": "4" } }, "status": "SUCCESS" "orderId": "ABC1234567890" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:payResp // block:start:onboardingAndCreateMandateReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "shouldCreateMandate": true, "initiationMode": "13", "purpose": "76", "payType":"P2M_PAY", "bankCodes": "["550055", "551100"]", // Only in case of TPV "transactionReference": "111-CM-1122334456-brokerref", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "metadata.:gateway_reference_id": "ABC123", "order_id": "ABC1234567890", "metadata.YES_BIZ:mandate_name": "metadata.YES_BIZ:ABC", "options.create_mandate": "REQUIRED", "mandate.max_amount": "2000.00", "mandate.amount_rule": "FIXED", "mandate.frequency": "MONTHLY", "bankAccountHashes": "["fejgfvhef67t376", "gryiu349rewiufdhsy8934"]", //Only in case of TPV "mandate.start_date": "166674893389237", "mandate.end_date": "16667389373820323", "mandate.block_fund": "true", "mandate.payer_revocable: "false" } // block:end:onboardingAndCreateMandateReq // block:start:onboardingAndCreateMandateResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "status": "SUCCESS", "mandate": { "amount": "10.00", "amountRule": "EXACT", "blockFund": "false", "expiry": "2022-01-02T14:17:06+05:30", "gatewayMandateId": "YJPMe5c9711f1ede1f5524e2fadb48003aa0", "gatewayReferenceId": "806115044725", "gatewayResponseCode": "00", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseStatus": "SUCCESS", "initiatedBy": "PAYER", "mandateName": "Test Mandate", "mandateTimestamp": "2021-12-30T14:17:06+05:30", "merchantCustomerId": "DEMO-1234", "merchantRequestId": "eulb1a4418b4ac", "orgMandateId": "BJJMe5c9711f1ede1f5524e2f92648y03aa0", "payeeMcc": "4924", "payeeName": "GROWW", "payeeVpa": "growwuat@ypay", "payerName": "customer1", "payerRevocable": "true", "payerVpa": "customer1@ypay", "recurrencePattern": "WEEKLY", "recurrenceRule": "BEFORE", "recurrenceValue": "2", "refUrl": "https://www.google.com", "remarks": "Sample Remarks", "role": "PAYER", "shareToPayee": "true", "transactionType": "UPI_MANDATE", "umn": "uniqueMandateNumber@ypay", "validityEnd": "2022/09/20", "validityStart": "2022/01/20" } }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:onboardingAndCreateMandateResp // block:start:createMandateReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "shouldCreateMandate": true, "merchantKeyId": "", "signature": "", "signaturePayload": "", "accountRefId" : "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "metadata.:gateway_reference_id": "ABC123", "order_id": "ABC1234567890", "metadata.YES_BIZ:mandate_name": "metadata.YES_BIZ:ABC", "options.create_mandate": "REQUIRED", "mandate.max_amount": "2000.00", "mandate.amount_rule": "FIXED", "mandate.frequency": "MONTHLY", "mandate.start_date": "166674893389237", "mandate.end_date": "16667389373820323" } // block:end:createMandateReq // block:start:createMandateResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "status": "SUCCESS", "mandate": { "amount": "10.00", "amountRule": "EXACT", "blockFund": "false", "expiry": "2022-01-02T14:17:06+05:30", "gatewayMandateId": "YJPMe5c9711f1ede1f5524e2fadb48003aa0", "gatewayReferenceId": "806115044725", "gatewayResponseCode": "00", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseStatus": "SUCCESS", "initiatedBy": "PAYER", "mandateName": "Test Mandate", "mandateTimestamp": "2021-12-30T14:17:06+05:30", "merchantCustomerId": "DEMO-1234", "merchantRequestId": "eulb1a4418b4ac", "orgMandateId": "BJJMe5c9711f1ede1f5524e2f92648y03aa0", "payeeMcc": "4924", "payeeName": "GROWW", "payeeVpa": "growwuat@ypay", "payerName": "customer1", "payerRevocable": "true", "payerVpa": "customer1@ypay", "recurrencePattern": "WEEKLY", "recurrenceRule": "BEFORE", "recurrenceValue": "2", "refUrl": "https://www.google.com", "remarks": "Sample Remarks", "role": "PAYER", "shareToPayee": "true", "transactionType": "UPI_MANDATE", "umn": "uniqueMandateNumber@ypay", "validityEnd": "2022/09/20", "validityStart": "2022/01/20" } }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:createMandateResp ``` ## 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: ### InappUI.txt ``` {"success":false,"message":"Failed to fetch snippet"} ``` --- ## See Also - [Bind and Activate Device](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/bind-and-activate-device) - [Get Accounts](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/get-accounts)