--- page_source: https://docs.juspay.io/upi-inapp/flutter/headless-process-payloads/upi-get-bank-list page_title: UPI Get Bank List --- ## 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 - **Name**: - Description: Name of the Bank - Value: Example: YES bank - Tags: String - **Iin**: - Description: IIN code for the bank - Value: Value: 123456 - Tags: String - **Ifsc**: - Description: IFSC code - Value: Example: ABCD0123456 - Tags: String - **Id**: - Description: Unique Identifier for the account - Value: Example: abcd1234xyz - Tags: String - Tags: Array of JSON - 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 // block:start:getSessionTokenReq { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "getSessionToken", "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": "getSessionToken", "status": "LINKED", "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: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" }, "vpa": "7834861582-gww@yesg" }] "selectedAccount": { "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true" }, "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": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "order_id": "ABC1234567890" } // block:end:onboardingAndPayReq // block:start:onboardingAndPayResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "payload": { "action": "onboardingAndPay", "status": "SUCCESS" }, "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", "order_id": "ABC1234567890" } // block:end:payReq // block:start:payResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "payload": { "action": "upiTxn", "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, "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "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:onboardingAndCreateMandateReq // block:start:onboardingAndCreateMandateResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "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", "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.hyperupi", "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": "getSessionToken", "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": "getSessionToken", "status": "LINKED", "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: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" }, "vpa": "7834861582-gww@yesg" }] "selectedAccount": { "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true" }, "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": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "order_id": "ABC1234567890" } // block:end:onboardingAndPayReq // block:start:onboardingAndPayResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "payload": { "action": "onboardingAndPay", "status": "SUCCESS" }, "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", "order_id": "ABC1234567890" } // block:end:payReq // block:start:payResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "payload": { "action": "upiTxn", "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, "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "200.00", "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:onboardingAndCreateMandateReq // block:start:onboardingAndCreateMandateResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "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", "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.hyperupi", "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 { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetBankList" } } ``` ### Response snippets: #### Response: ```plaintext { "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 } ```