--- page_title: Check Balance product: UPI Plugin SDK platform: Android page_source: https://juspay.io/in/docs/upi-plugin-sdk/android/process-payloads/check-balance llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-plugin-sdk/llms.txt --- ## Check Balance This operation will provide the merchant to check balance of a account. ### 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. - Value: upiCheckBalance - Tags: String, Mandatory - **UpiRequestId**: - Description: Unique identifier (uuid) for the request sent to NPCI - Tags: String, Mandatory - **AccountReferenceId**: - Description: ReferenceId of the account whose balance is to be checked. Incase of lite account, ReferenceId of the same as received in response of upiGetSessionToken - 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 to be performed in the SDK. - Value: upiCheckBalance - Tags: String, Mandatory - **BankAccountUniqueId**: - Description: Unique Identifier for bank account across banks - Tags: String, Mandatory - **AccountReferenceId**: - Description: Unique Identifier for the account whose balance is to be checked. - Tags: String, Mandatory - **BankCode**: - Description: IIN Code for the bank - Tags: String, Mandatory - **CustomerMobileNumber**: - Description: masked phone number of the customer - Value: - Tags: String, Mandatory - **MaskedAccountNumber**: - Description: Account Number with last few digits visible - Tags: String, Mandatory - **Status**: - Description: If upiCheckBalance call was success or failure - Value: SUCCESS / FAILURE - Tags: String, Mandatory - **GatewayResponseCode**: - Description: Response Code received from NPCI - Tags: String, Mandatory - **GatewayResponseMessage**: - Description: Response Message received from NPCI - Tags: String, Mandatory - **Balance**: - Description: Account Balance - Tags: String, Optional - **AvailableBalance**: - Tags: String, Optional - **OtherInfo**: - Description: As passed in request - Tags: 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": "upiCheckBalance", "upiRequestId": "", "accountReferenceId": "" } } ``` #### Kotlin Code Snippet: ```kotlin { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckBalance", "upiRequestId": "", "accountReferenceId": "" } } ``` ## Sample Code Snippets: ### Request snippets: #### Request Code Snippet: ```request // block:start:changeMpinReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiChangeMpin", "upiRequestId": "", "accountReferenceId": "", } } // block:end:changeMpinReqH // block:start:changeMpinRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiChangeMpin", "status": "SUCCESS", "bankCode": "123456", "customerMobileNumber": "7777777777", "accountReferenceId": "", "bankAccountUniqueId": "", "customerVpa": "something@handle", "maskedAccountNumber": "XXXX1234", "gatewayResponseCode": "", "gatewayResponseMessage": "" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:changeMpinRespH // block:start:payRequestH { "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:payRequestH // block:start:payResponseH { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "payeeMcc": "0000", "transactionTimestamp": "2024-11-08T13:17:56+05:30", "customerMobileNumber": "919999988888", "gatewayReferenceId": "4313453453", "bankAccountUniqueId": "a6ee64432a8365e0e36c61e657fbac8d79d31936491ce5d9fe41c6ded30fa4cb", "selectedAccount": { "vpa": "XXX@ABC", "account": { "ifsc": "BANK0006029", "name": "CustomerName", "type": "SAVINGS", "branchName": "", "bankAccountUniqueId": "a6ee64432a8365e0e36c61e657fbac8d79d31936534h5345h345", "mpinSet": "true", "bankCode": "000000", "atmPinLength": "4", "supportedFeatures": { "recurrenceMandate": true, "upiCredit": false, "aadhaar": true, "fir": true, "emi": false, "liteOffline": true, "base": true, "nfs": false, "global": true, "ccBill": false, "clDynamicKeys": false, "voucherManagementSystem": false, "credit": false, "mandate": true, "lite": true }, "mpinLength": "4", "referenceId": "A4265asadfasdfasdf5345", "maskedAccountNumber": "XXXXXX8590", "isPrimary": "true", "bankName": "BANK LTD", "otpLength": "6" } }, "bankCode": "000000", "refUrl": "https://www.juspay.com/", "status": "SUCCESS", "gatewayResponseCode": "00", "action": "upiTxn", "gatewayTransactionId": "YJP1506cb5bedc7sdfasdfbf5057af5684d646", "maskedAccountNumber": "XXXXXX8590", "udfParameters": "{}", "gatewayResponseMessage": "Your transaction is successful", "amount": "20.00", "customerVpa": "XXX@ABC" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:payResponseH // block:start:p2pCreateMandateReqH { "service": "in.juspay.hyperapi", "requestId": "c7f8995c-679d-4ff4-8b55-a1b0a3f227a4", "payload": { "validityStart": "2022/06/11", "validityEnd": "2023/05/15", "upiRequestId": "AX7834861502", "transactionType": "INTENT_MANDATE", "transactionReference": "1234567890", "timestamp": "1656567717539.0", "signaturePayload": "", "signature": "", "recurrenceValue": "2", "recurrenceRule": "BEFORE", "recurrencePattern": "WEEKLY", "recipientName": "ABC", "purpose": "14", "payerVpa": "venkat337@axisbiz", "payeeVpa": "gvkaaaa@stockaxis", "merchantKeyId": "3440", "mcc": "1234", "mandateName": "ABC", "initiationMode": "02", "initiatedBy": "PAYER", "currency": "INR", "blockFund": "false", "bankAccountUniqueId": "", "amountRule": "EXACT", "amount": "3000.00", "accountReferenceId": "Ace797b05c1d453ca3b0d060695192", "action": "upiCreateMandate" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "3000.00", "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:p2pCreateMandateReqH // block:start:p2pCreateMandateRespH { "service": "in.juspay.hyperapi", "requestId": "b0d7c0a9-20f2-4e32-9085-15bf2a384200", "payload": { "status": "SUCCESS", "responseMessage": "SUCCESS", "responseCode": "SUCCESS", "mandatePayload": { "validityStart": "2022/07/11", "validityEnd": "2023/05/15", "umn": "e2bf05b384b844b9b727e513e3429f8e@axisbiz", "transactionType": "INTENT_MANDATE", "shareToPayee": "true", "role": "PAYER", "remarks": "bill", "refUrl": "https://www.juspay.com/", "recurrenceValue": "2", "recurrenceRule": "BEFORE", "recurrencePattern": "WEEKLY", "payerVpa": "something@handle", "payerRevocable": "true", "payeeVpa": "something@handle", "payeeName": "ABC", "payeeMcc": "0000", "orgMandateId": "AX7834861102", "merchantRequestId": "834861102", "merchantCustomerId": "1234567891", "mandateTimestamp": "2022-06-30T12:56:46+05:30", "mandateName": "XYZ", "initiatedBy": "PAYER", "gatewayResponseStatus": "SUCCESS", "gatewayResponseMessage": "", "gatewayResponseCode": "00", "gatewayReferenceId": "218157918989", "gatewayMandateId": "AX7834861102", "blockFund": "false", "bankAccountUniqueId": "f120f755ff68e41dde5b2dfb4c1d03e94e0a3d0b9021622b588103d81d8cc254", "amountRule": "EXACT", "amount": "3000.00", "accountReferenceId": "", }, "action": "upiCreateMandate" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:p2pCreateMandateRespH // block:start:makePrimaryReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiMakePrimary", "customerVpa": "something@handle", "accountReferenceId": "acc2" } } // block:end:makePrimaryReqH // block:start:makePrimaryRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiMakePrimary", "status": "SUCCESS", "customerMobileNumber": "XXXX7890", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "something@handle" }], "gatewayResponseCode": "00", "gatewayResponseMessage": "SUCCESS" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:makePrimaryRespH // block:start:checkBalanceReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckBalance", "upiRequestId": "", "accountReferenceId": "" } } // block:end:checkBalanceReqH // block:start:checkBalanceRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckBalance", "status": "SUCCESS" / "FAILURE", "accountReferenceId": "", "bankAccountUniqueId": "", "bankCode": "11111", "customerMobileNumber": "XXXX7890", "maskedAccountNumber": "XXXX1234", "gatewayResponseCode": "", "gatewayResponseMessage": "", "balance": "", "outstandingAmount": "" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:checkBalanceRespH // block:start:deleteReqH { "service": "in.juspay.hyperapi", "requestId": "8da4c755-0c82-4efb-a1b3-5ba8c84c659b", "payload": { "action": "upiDeleteAccount", "accountReferenceId": "Ac3a09bcc26149b7bdd009e57911fbb", } } // block:end:deleteReqH // block:start:deleteRespH { "service": "in.juspay.hyperapi", "requestId": "8da4c755-0c82-4efb-a1b3-5ba8c84c659b", "payload": { "vpaAccounts": "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "something@handle", "isDefault": "true" }], "status": "SUCCESS", "customerMobileNumber": "911234567891", "action": "upiDeleteAccount" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:deleteRespH // block:start:requestMoneyReqH { "service": "in.juspay.hyperapi", "requestId": "9863bf03-cd26-4fe0-9b71-1200bc7e5506", "payload": { "action": "upiRequestMoney", "accountReferenceId": "XXXXXXXXXXXXXXXX", "upiRequestId": "XXXXXXXXXXXXXXXX", "timestamp": "1639129434233", "remarks": "pa", "payerName": "ABC", "payerVpa": "XXXXXXXX@XXXXXXXX", "collectRequestExpiryMinutes": "2", "customerVpa": "XXXXXXXX@XXXXXXXX", "amount": "100.00", "signature": "cCDo6KtDmGM.......Pl8HAlLc==", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639129434233", "amount": "100.00", } // block:end:requestMoneyReqH // block:start:requestMoneyRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "transactionTimestamp": "2021-12-11T01:54:27+05:30", "status": "SUCCESS", "maskedAccountNumber": "XXXXXXXXXXXXXXXX", "gatewayTransactionId": "XXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Collect request sent successfully", "gatewayResponseCode": "00", "gatewayReferenceId": "XXXXXXXXXXX", "customerVpa": "XXXXXXXX@XXXXXX", "customerMobileNumber": "XXXXXXXXX", "bankCode": "500007", "bankAccountUniqueId": "XXXXXXXXXXXXXXXXXXXXXXXXX", "amount": "1.00", "action": "upiRequestMoney" "refUrl": "www.google.com" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:requestMoneyRespH // block:start:listPendingTransactionsReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "limit": "100", "offset": "0", "action": "upiListPendingTransactions" } } // block:end:listPendingTransactionsReqH // block:start:listPendingTransactionsRespH { "service": "in.juspay.hyperapi", "requestId": "621e5bc9-a06a-4593-a16a-1be7d01d1cac", "payload": { "status": "SUCCESS", "count": "100", "pendingTransactions": [ { }, { } ], "action": "upiListPendingTransactions" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listPendingTransactionsRespH ``` ### Response snippets: #### Response: ```plaintext // block:start:changeMpinReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiChangeMpin", "upiRequestId": "", "accountReferenceId": "", } } // block:end:changeMpinReqH // block:start:changeMpinRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiChangeMpin", "status": "SUCCESS", "bankCode": "123456", "customerMobileNumber": "7777777777", "accountReferenceId": "", "bankAccountUniqueId": "", "customerVpa": "something@handle", "maskedAccountNumber": "XXXX1234", "gatewayResponseCode": "", "gatewayResponseMessage": "" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:changeMpinRespH // block:start:payRequestH { "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:payRequestH // block:start:payResponseH { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "payeeMcc": "0000", "transactionTimestamp": "2024-11-08T13:17:56+05:30", "customerMobileNumber": "919999988888", "gatewayReferenceId": "4313453453", "bankAccountUniqueId": "a6ee64432a8365e0e36c61e657fbac8d79d31936491ce5d9fe41c6ded30fa4cb", "selectedAccount": { "vpa": "XXX@ABC", "account": { "ifsc": "BANK0006029", "name": "CustomerName", "type": "SAVINGS", "branchName": "", "bankAccountUniqueId": "a6ee64432a8365e0e36c61e657fbac8d79d31936534h5345h345", "mpinSet": "true", "bankCode": "000000", "atmPinLength": "4", "supportedFeatures": { "recurrenceMandate": true, "upiCredit": false, "aadhaar": true, "fir": true, "emi": false, "liteOffline": true, "base": true, "nfs": false, "global": true, "ccBill": false, "clDynamicKeys": false, "voucherManagementSystem": false, "credit": false, "mandate": true, "lite": true }, "mpinLength": "4", "referenceId": "A4265asadfasdfasdf5345", "maskedAccountNumber": "XXXXXX8590", "isPrimary": "true", "bankName": "BANK LTD", "otpLength": "6" } }, "bankCode": "000000", "refUrl": "https://www.juspay.com/", "status": "SUCCESS", "gatewayResponseCode": "00", "action": "upiTxn", "gatewayTransactionId": "YJP1506cb5bedc7sdfasdfbf5057af5684d646", "maskedAccountNumber": "XXXXXX8590", "udfParameters": "{}", "gatewayResponseMessage": "Your transaction is successful", "amount": "20.00", "customerVpa": "XXX@ABC" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:payResponseH // block:start:p2pCreateMandateReqH { "service": "in.juspay.hyperapi", "requestId": "c7f8995c-679d-4ff4-8b55-a1b0a3f227a4", "payload": { "validityStart": "2022/06/11", "validityEnd": "2023/05/15", "upiRequestId": "AX7834861502", "transactionType": "INTENT_MANDATE", "transactionReference": "1234567890", "timestamp": "1656567717539.0", "signaturePayload": "", "signature": "", "recurrenceValue": "2", "recurrenceRule": "BEFORE", "recurrencePattern": "WEEKLY", "recipientName": "ABC", "purpose": "14", "payerVpa": "venkat337@axisbiz", "payeeVpa": "gvkaaaa@stockaxis", "merchantKeyId": "3440", "mcc": "1234", "mandateName": "ABC", "initiationMode": "02", "initiatedBy": "PAYER", "currency": "INR", "blockFund": "false", "bankAccountUniqueId": "", "amountRule": "EXACT", "amount": "3000.00", "accountReferenceId": "Ace797b05c1d453ca3b0d060695192", "action": "upiCreateMandate" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "3000.00", "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:p2pCreateMandateReqH // block:start:p2pCreateMandateRespH { "service": "in.juspay.hyperapi", "requestId": "b0d7c0a9-20f2-4e32-9085-15bf2a384200", "payload": { "status": "SUCCESS", "responseMessage": "SUCCESS", "responseCode": "SUCCESS", "mandatePayload": { "validityStart": "2022/07/11", "validityEnd": "2023/05/15", "umn": "e2bf05b384b844b9b727e513e3429f8e@axisbiz", "transactionType": "INTENT_MANDATE", "shareToPayee": "true", "role": "PAYER", "remarks": "bill", "refUrl": "https://www.juspay.com/", "recurrenceValue": "2", "recurrenceRule": "BEFORE", "recurrencePattern": "WEEKLY", "payerVpa": "something@handle", "payerRevocable": "true", "payeeVpa": "something@handle", "payeeName": "ABC", "payeeMcc": "0000", "orgMandateId": "AX7834861102", "merchantRequestId": "834861102", "merchantCustomerId": "1234567891", "mandateTimestamp": "2022-06-30T12:56:46+05:30", "mandateName": "XYZ", "initiatedBy": "PAYER", "gatewayResponseStatus": "SUCCESS", "gatewayResponseMessage": "", "gatewayResponseCode": "00", "gatewayReferenceId": "218157918989", "gatewayMandateId": "AX7834861102", "blockFund": "false", "bankAccountUniqueId": "f120f755ff68e41dde5b2dfb4c1d03e94e0a3d0b9021622b588103d81d8cc254", "amountRule": "EXACT", "amount": "3000.00", "accountReferenceId": "", }, "action": "upiCreateMandate" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:p2pCreateMandateRespH // block:start:makePrimaryReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiMakePrimary", "customerVpa": "something@handle", "accountReferenceId": "acc2" } } // block:end:makePrimaryReqH // block:start:makePrimaryRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiMakePrimary", "status": "SUCCESS", "customerMobileNumber": "XXXX7890", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "something@handle" }], "gatewayResponseCode": "00", "gatewayResponseMessage": "SUCCESS" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:makePrimaryRespH // block:start:checkBalanceReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckBalance", "upiRequestId": "", "accountReferenceId": "" } } // block:end:checkBalanceReqH // block:start:checkBalanceRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckBalance", "status": "SUCCESS" / "FAILURE", "accountReferenceId": "", "bankAccountUniqueId": "", "bankCode": "11111", "customerMobileNumber": "XXXX7890", "maskedAccountNumber": "XXXX1234", "gatewayResponseCode": "", "gatewayResponseMessage": "", "balance": "", "outstandingAmount": "" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:checkBalanceRespH // block:start:deleteReqH { "service": "in.juspay.hyperapi", "requestId": "8da4c755-0c82-4efb-a1b3-5ba8c84c659b", "payload": { "action": "upiDeleteAccount", "accountReferenceId": "Ac3a09bcc26149b7bdd009e57911fbb", } } // block:end:deleteReqH // block:start:deleteRespH { "service": "in.juspay.hyperapi", "requestId": "8da4c755-0c82-4efb-a1b3-5ba8c84c659b", "payload": { "vpaAccounts": "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "something@handle", "isDefault": "true" }], "status": "SUCCESS", "customerMobileNumber": "911234567891", "action": "upiDeleteAccount" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:deleteRespH // block:start:requestMoneyReqH { "service": "in.juspay.hyperapi", "requestId": "9863bf03-cd26-4fe0-9b71-1200bc7e5506", "payload": { "action": "upiRequestMoney", "accountReferenceId": "XXXXXXXXXXXXXXXX", "upiRequestId": "XXXXXXXXXXXXXXXX", "timestamp": "1639129434233", "remarks": "pa", "payerName": "ABC", "payerVpa": "XXXXXXXX@XXXXXXXX", "collectRequestExpiryMinutes": "2", "customerVpa": "XXXXXXXX@XXXXXXXX", "amount": "100.00", "signature": "cCDo6KtDmGM.......Pl8HAlLc==", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639129434233", "amount": "100.00", } // block:end:requestMoneyReqH // block:start:requestMoneyRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "transactionTimestamp": "2021-12-11T01:54:27+05:30", "status": "SUCCESS", "maskedAccountNumber": "XXXXXXXXXXXXXXXX", "gatewayTransactionId": "XXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Collect request sent successfully", "gatewayResponseCode": "00", "gatewayReferenceId": "XXXXXXXXXXX", "customerVpa": "XXXXXXXX@XXXXXX", "customerMobileNumber": "XXXXXXXXX", "bankCode": "500007", "bankAccountUniqueId": "XXXXXXXXXXXXXXXXXXXXXXXXX", "amount": "1.00", "action": "upiRequestMoney" "refUrl": "www.google.com" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:requestMoneyRespH // block:start:listPendingTransactionsReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "limit": "100", "offset": "0", "action": "upiListPendingTransactions" } } // block:end:listPendingTransactionsReqH // block:start:listPendingTransactionsRespH { "service": "in.juspay.hyperapi", "requestId": "621e5bc9-a06a-4593-a16a-1be7d01d1cac", "payload": { "status": "SUCCESS", "count": "100", "pendingTransactions": [ { }, { } ], "action": "upiListPendingTransactions" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listPendingTransactionsRespH ``` --- ## Complete Code Reference The following code files are referenced in the steps above: ### InappHeadless1.txt ``` // block:start:changeMpinReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiChangeMpin", "upiRequestId": "", "accountReferenceId": "", } } // block:end:changeMpinReqH // block:start:changeMpinRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiChangeMpin", "status": "SUCCESS", "bankCode": "123456", "customerMobileNumber": "7777777777", "accountReferenceId": "", "bankAccountUniqueId": "", "customerVpa": "something@handle", "maskedAccountNumber": "XXXX1234", "gatewayResponseCode": "", "gatewayResponseMessage": "" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:changeMpinRespH // block:start:payRequestH { "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:payRequestH // block:start:payResponseH { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "payeeMcc": "0000", "transactionTimestamp": "2024-11-08T13:17:56+05:30", "customerMobileNumber": "919999988888", "gatewayReferenceId": "4313453453", "bankAccountUniqueId": "a6ee64432a8365e0e36c61e657fbac8d79d31936491ce5d9fe41c6ded30fa4cb", "selectedAccount": { "vpa": "XXX@ABC", "account": { "ifsc": "BANK0006029", "name": "CustomerName", "type": "SAVINGS", "branchName": "", "bankAccountUniqueId": "a6ee64432a8365e0e36c61e657fbac8d79d31936534h5345h345", "mpinSet": "true", "bankCode": "000000", "atmPinLength": "4", "supportedFeatures": { "recurrenceMandate": true, "upiCredit": false, "aadhaar": true, "fir": true, "emi": false, "liteOffline": true, "base": true, "nfs": false, "global": true, "ccBill": false, "clDynamicKeys": false, "voucherManagementSystem": false, "credit": false, "mandate": true, "lite": true }, "mpinLength": "4", "referenceId": "A4265asadfasdfasdf5345", "maskedAccountNumber": "XXXXXX8590", "isPrimary": "true", "bankName": "BANK LTD", "otpLength": "6" } }, "bankCode": "000000", "refUrl": "https://www.juspay.com/", "status": "SUCCESS", "gatewayResponseCode": "00", "action": "upiTxn", "gatewayTransactionId": "YJP1506cb5bedc7sdfasdfbf5057af5684d646", "maskedAccountNumber": "XXXXXX8590", "udfParameters": "{}", "gatewayResponseMessage": "Your transaction is successful", "amount": "20.00", "customerVpa": "XXX@ABC" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:payResponseH // block:start:p2pCreateMandateReqH { "service": "in.juspay.hyperapi", "requestId": "c7f8995c-679d-4ff4-8b55-a1b0a3f227a4", "payload": { "validityStart": "2022/06/11", "validityEnd": "2023/05/15", "upiRequestId": "AX7834861502", "transactionType": "INTENT_MANDATE", "transactionReference": "1234567890", "timestamp": "1656567717539.0", "signaturePayload": "", "signature": "", "recurrenceValue": "2", "recurrenceRule": "BEFORE", "recurrencePattern": "WEEKLY", "recipientName": "ABC", "purpose": "14", "payerVpa": "venkat337@axisbiz", "payeeVpa": "gvkaaaa@stockaxis", "merchantKeyId": "3440", "mcc": "1234", "mandateName": "ABC", "initiationMode": "02", "initiatedBy": "PAYER", "currency": "INR", "blockFund": "false", "bankAccountUniqueId": "", "amountRule": "EXACT", "amount": "3000.00", "accountReferenceId": "Ace797b05c1d453ca3b0d060695192", "action": "upiCreateMandate" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848", "amount": "3000.00", "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:p2pCreateMandateReqH // block:start:p2pCreateMandateRespH { "service": "in.juspay.hyperapi", "requestId": "b0d7c0a9-20f2-4e32-9085-15bf2a384200", "payload": { "status": "SUCCESS", "responseMessage": "SUCCESS", "responseCode": "SUCCESS", "mandatePayload": { "validityStart": "2022/07/11", "validityEnd": "2023/05/15", "umn": "e2bf05b384b844b9b727e513e3429f8e@axisbiz", "transactionType": "INTENT_MANDATE", "shareToPayee": "true", "role": "PAYER", "remarks": "bill", "refUrl": "https://www.juspay.com/", "recurrenceValue": "2", "recurrenceRule": "BEFORE", "recurrencePattern": "WEEKLY", "payerVpa": "something@handle", "payerRevocable": "true", "payeeVpa": "something@handle", "payeeName": "ABC", "payeeMcc": "0000", "orgMandateId": "AX7834861102", "merchantRequestId": "834861102", "merchantCustomerId": "1234567891", "mandateTimestamp": "2022-06-30T12:56:46+05:30", "mandateName": "XYZ", "initiatedBy": "PAYER", "gatewayResponseStatus": "SUCCESS", "gatewayResponseMessage": "", "gatewayResponseCode": "00", "gatewayReferenceId": "218157918989", "gatewayMandateId": "AX7834861102", "blockFund": "false", "bankAccountUniqueId": "f120f755ff68e41dde5b2dfb4c1d03e94e0a3d0b9021622b588103d81d8cc254", "amountRule": "EXACT", "amount": "3000.00", "accountReferenceId": "", }, "action": "upiCreateMandate" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:p2pCreateMandateRespH // block:start:makePrimaryReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiMakePrimary", "customerVpa": "something@handle", "accountReferenceId": "acc2" } } // block:end:makePrimaryReqH // block:start:makePrimaryRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiMakePrimary", "status": "SUCCESS", "customerMobileNumber": "XXXX7890", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "something@handle" }], "gatewayResponseCode": "00", "gatewayResponseMessage": "SUCCESS" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:makePrimaryRespH // block:start:checkBalanceReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckBalance", "upiRequestId": "", "accountReferenceId": "" } } // block:end:checkBalanceReqH // block:start:checkBalanceRespH { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "upiCheckBalance", "status": "SUCCESS" / "FAILURE", "accountReferenceId": "", "bankAccountUniqueId": "", "bankCode": "11111", "customerMobileNumber": "XXXX7890", "maskedAccountNumber": "XXXX1234", "gatewayResponseCode": "", "gatewayResponseMessage": "", "balance": "", "outstandingAmount": "" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:checkBalanceRespH // block:start:deleteReqH { "service": "in.juspay.hyperapi", "requestId": "8da4c755-0c82-4efb-a1b3-5ba8c84c659b", "payload": { "action": "upiDeleteAccount", "accountReferenceId": "Ac3a09bcc26149b7bdd009e57911fbb", } } // block:end:deleteReqH // block:start:deleteRespH { "service": "in.juspay.hyperapi", "requestId": "8da4c755-0c82-4efb-a1b3-5ba8c84c659b", "payload": { "vpaAccounts": "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "something@handle", "isDefault": "true" }], "status": "SUCCESS", "customerMobileNumber": "911234567891", "action": "upiDeleteAccount" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:deleteRespH // block:start:requestMoneyReqH { "service": "in.juspay.hyperapi", "requestId": "9863bf03-cd26-4fe0-9b71-1200bc7e5506", "payload": { "action": "upiRequestMoney", "accountReferenceId": "XXXXXXXXXXXXXXXX", "upiRequestId": "XXXXXXXXXXXXXXXX", "timestamp": "1639129434233", "remarks": "pa", "payerName": "ABC", "payerVpa": "XXXXXXXX@XXXXXXXX", "collectRequestExpiryMinutes": "2", "customerVpa": "XXXXXXXX@XXXXXXXX", "amount": "100.00", "signature": "cCDo6KtDmGM.......Pl8HAlLc==", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639129434233", "amount": "100.00", } // block:end:requestMoneyReqH // block:start:requestMoneyRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "transactionTimestamp": "2021-12-11T01:54:27+05:30", "status": "SUCCESS", "maskedAccountNumber": "XXXXXXXXXXXXXXXX", "gatewayTransactionId": "XXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Collect request sent successfully", "gatewayResponseCode": "00", "gatewayReferenceId": "XXXXXXXXXXX", "customerVpa": "XXXXXXXX@XXXXXX", "customerMobileNumber": "XXXXXXXXX", "bankCode": "500007", "bankAccountUniqueId": "XXXXXXXXXXXXXXXXXXXXXXXXX", "amount": "1.00", "action": "upiRequestMoney" "refUrl": "www.google.com" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:requestMoneyRespH // block:start:listPendingTransactionsReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "limit": "100", "offset": "0", "action": "upiListPendingTransactions" } } // block:end:listPendingTransactionsReqH // block:start:listPendingTransactionsRespH { "service": "in.juspay.hyperapi", "requestId": "621e5bc9-a06a-4593-a16a-1be7d01d1cac", "payload": { "status": "SUCCESS", "count": "100", "pendingTransactions": [ { }, { } ], "action": "upiListPendingTransactions" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listPendingTransactionsRespH ``` --- ## See Also - [UPI Onboarding and Pay](https://juspay.io/in/docs/upi-plugin-sdk/android/process-payloads/upi-onboarding) - [UPI Management](https://juspay.io/in/docs/upi-plugin-sdk/android/process-payloads/upi-management)