--- page_title: Blocked Vpa List product: UPI TPAP SDK platform: Android page_source: https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/blocked-vpa-list llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt --- ## Blocked Vpa List The merchant can call this API to get a list of blocked vpas. ### 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: upiBlockedVpaList - Tags: String, Mandatory - **Offset**: - Description: Offset of vpas to be returned - Value: eg. 0 - Tags: Int, Mandatory - **Limit**: - Description: Limit of vpas to be returned - Value: eg. 100 - Tags: Int, Mandatory - **MerchantKeyId**: - Description: Key ID to identify the public-private key pair used for signature generation. - Tags: String, Mandatory - **SignaturePayload**: - Description: Signature payload is a stringified JSON of the details mentioned in the below table. - Value: - **Merchant_id**: - Description: Unique identifier associated with an account created by juspay. Ex: stock - Tags: String, Mandatory - **Customer_id**: - Description: Any unique reference associated with your customer. - Tags: String, Mandatory - **Timestamp**: - Description: Time when request is created in milliseconds. - Tags: String, Mandatory - Tags: String, Mandatory - **Signature**: - Description: Signature generated for the signaturePayload - Tags: String, Optional - Tags: JSON, Mandatory ## Response Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: Example: abcd-12345-abcd-12345 - Tags: String - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String - **Payload**: - Description: Response Parameters - Value: - **Action**: - Description: Operation to be performed in the SDK. Should be upiBlockedVpaList for this call. - Value: upiBlockedVpaList - Tags: String, Mandatory - **MerchantId**: - Description: Unique id for the merchant as passed in request - Tags: String, Mandatory - **MerchantChannelId**: - Description: Unique id for the merchant channel as passed in request - Tags: String, Mandatory - **MerchantCustomerId**: - Description: Merchant generated unique profile id for customer as passed in the request - Tags: String, Mandatory - **BlockedVpas**: - Description: Array of blocked vpas - Value: - **PayeeVpa**: - Description: Blocked payee VPA - Tags: String, Mandatory - **Name**: - Description: Name of the user - Tags: String, Mandatory - **BlockedAt**: - Description: Time when VPA was blocked - Tags: String, Mandatory - Tags: Array of JSON, Mandatory - 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:listTransactionsReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "GFe…………………..w==", "merchantKeyId": "1234", "limit": "100", "offset": "0", "action": "upiTransactionList", } } "signaturePayload": { "merchant_id": "stock", "timestamp": "1639147293629" "customer_id":"9876543210", } // block:end:listTransactionsReqH // block:start:listTransactionsRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "status": "SUCCESS", "merchantChannelId": "STOCKAPP" "merchantCustomerId": "9876543210" "merchantId": "stock" "txnList": [ { }, { } ], "action": "upiTransactionList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listTransactionsRespH // block:start:transactionStatusReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxnStatus", "signature": "", "signaturePayload": "", "merchantKeyId":"1234", "upiRequestId": "", "transactionType": "CUSTOMER_DEBITED_VIA_PAY", "transactionTimestamp": "1639147293629", "vpa": "abc@xyz", "checkWithUdir":"true", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1639147293629", } // block:end:transactionStatusReqH // block:start:transactionStatusRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "status": "SUCCESS", "udfParameters":"{}", "type":"CUSTOMER_DEBITED_VIA_PAY", "transactionTimestamp":"2016-11-25T00:00:00+05:30", "responseMessage":"SUCCESS", "responseCode":"SUCCESS", "refUrl":"https://www.abcxyz.com/", "payerVpa":"customer@xyz"", "payerMobileNumber":"919812388554", "payerMerchantCustomerId":"DEMO-CUST-1234", "payeeVpa":"customer1@abc", "payeeName":"abc", "payeeMcc":"7322", "merchantRequestId":"22209140384", "merchantId\":"ONECARD", "merchantCustomerId":"2955809234891040000", "maskedAccountNumber":"652912XXXXXXXX29", "gatewayTransactionId":"YJPfd78b8d61ca8472b99ef.....", "gatewayResponseMessage":"Transaction is approved", "gatewayResponseCode":"00", "gatewayReferenceId":"538593539023", "customResponse":"{}", "bankCode":"123456", "bankAccountUniqueId":"fb96f8b2b1ab0c070d0d894", "amount":"4923.00", "action":"upiTxnStatus" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:transactionStatusRespH // block:start:raiseComplaintReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "upiRequestId": "AUT699393106f865d1a9467c59725e6891f", "originalUpiRequestId": "AUT75533106f865d1a9wegrhjw9725e6891f" "adjAmount": "0.50", "adjFlag": "PBRB", "adjCode": "U010", "action": "upiComplaintRaise", "type":"COMPLAINT", "purpose": "00", "refUrl": "https://www.abcxyz.com/", "remarks": "Amount not credited", "signature": "", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:raiseComplaintReqH // block:start:raiseComplaintRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiComplaintRaise", "status": "SUCCESS", "responseCode": "SUCCESS", "responseMessage": "SUCCESS", "complaintRaisePayload": { "payerVpa": "123454306@1234", "payeeVpa": "83746598743@2312", "merchantId": "TEST", "merchantChannelId": "TESTAPP", "merchantCustomerId": "test-merchantcustomer-1", "customerMobileNumber": "919988776655", "merchantRequestId": "3764723469", "transactionAmount": "1.00", "reqAdjAmount": "0.50", "reqAdjFlag": "PBRB", "reqAdjCode": "U010", "crn": "941451534851394", "gatewayReferenceId": "123456", "gatewayComplaintId": "AUT699393106f865d1a9467c59725e6891f", "gatewayResponseCode": "00", "gatewayResponseStatus": "SUCCESS", "gatewayResponseMessage": "Your Complaint is Raised" } }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:raiseComplaintRespH // block:start:listPendingComplaintReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "action": "upiListPendingComplaints", "limit": 100, "offset": 0, "signature": "", "signaturePayload": "", "merchantKeyId": "1234" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:listPendingComplaintReqH // block:start:listPendingComplaintRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiListPendingComplaints", "status": "SUCCESS", "responseCode": "SUCCESS", "responseMessage": "SUCCESS", "merchantId": "stock", "merchantChannelId": "stockAPP", "complaintList": [{ "upiRequestId": "72832032893287", "transactionUpiRequestId": "3764723469", "status": "SUCCESS", "reqAdjFlag": "PBRB", "reqAdjAmount": "0.50", "reqAdjCode": "U010", "remarks": "UPI", "payerVpa": "123454306@1234", "payeeVpa": "83746598743@2312", "orgTxnStatus": "SUCCESS", "orgTxnDate": "16683984398", "crn": "941451534851394", "complaintDate": "16683984398", }] }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listPendingComplaintRespH // block:start:complaintStatusReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "action": "upiComplaintStatus", "originalUpiRequestId": "APL699393106f8sbsbnbnns67c59725e6891f", "originalTransactionUpiRequestId": "APL699393106f865d1a9467c59725e6891f", "signature": "", "signaturePayload": "", "merchantKeyId": "1234" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:complaintStatusReqH // block:start:complaintStatusRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiComplaintStatus" "status": "SUCCESS", "responseMessage": "SUCCESS", "responseCode": "SUCCESS", "complaintStatusPayload": { "merchantChannelId": "stockAPP", "gatewayResponseStatus": "FAILURE", "merchantId": "stock", "gatewayComplaintId": "ICIJP22d737c1b544f7aa55f049ad84497b", "reqAdjAmount": "6600.00", "gatewayResponseMessage": "Transaction failed", "payerVpa": "something@handle", "merchantRequestId": "45f54883f5548ddac7bd4b16bd06e1d", "gatewayResponseCode": "U48", "gatewayReferenceId": "208409676817", "reqAdjCode": "U010", "crn": "UPI22032564889", "customerMobileNumber": "918086332344", "payeeVpa": "something@handle", "reqAdjFlag": "PBRB", "transactionAmount": "1.00", "merchantCustomerId": "090d5030-7d17-11ec-939b-b1ce4bc73875", "adjAmount": "0.50", "adjFlag": "PBRB", "adjCode": "U010", } } "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:complaintStatusRespH // block:start:collectApproveReqH { "service": "in.juspay.hyperapi", "requestId": "96ad03b7-c298-4702-9257-83ce9225485d", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168104341.0", "signaturePayload": "", "signature": "GFetNZC/UQ5hJF+MnaZ1dCD25GSeyFmm2cBY+rIkOhZDnR+icvl95g/1Dx4B9p/KE/ILkyBNOGNO\nDUBnxoaFeqhGE1pP3krWHcD2H2dJSTmcv7BvxeJKMdw==\n", "payeeVpa": "XXXXXXXXXXXXXXXX@XXXXXXXX", "merchantKeyId": "1234", "customerVpa": "XXXXXXXXXXXXXXXX@XXXXXXXX", "amount": "1.00", "accountReferenceId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "action": "upiPayCollect", "clAuthMode": “MPIN"/“BIOMETRICS” } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639167811935", "amount": "5.00", "currency": "INR" } // block:end:collectApproveReqH // block:start:collectApproveRespH { "service": "in.juspay.hyperapi", "requestId": "96ad03b7-c298-4702-9257-83ce9225485d", "payload": { "transactionTimestamp": "2021-12-11T01:54:28+05:30", "status": "SUCCESS", "maskedAccountNumber": "XXXXXXXXXX998898", "gatewayTransactionId": "XXXXXXXXXXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseCode": "00", "gatewayReferenceId": "XXXXXXXXXXXX", "payeeMcc": "0000", "customerVpa": "XXXXXX@XXXXXX", "customerMobileNumber": "XXXXXXXXXXXX", "bankCode": "500007", "bankAccountUniqueId": "XXXXXXXXXXXXXXXXXXXXXXXXX", "amount": "1.00", "refUrl": "https://www.abcxyz.com/", "action": "upiPayCollect", "clAuthMode": “MPIN"/“BIOMETRICS” }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:collectApproveRespH // block:start:collectDeclineReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168319187.0", "signaturePayload": "", "signature": "GF.........\n", "payeeVpa": "XXXXXXXXXX@XXXXXX", "payeeName": "ABC", "merchantKeyId": "1234", "customerVpa": "XXXXXXXXX@XXXXX", "amount": "5.00", "accountReferenceId": "XXXXXXXXXXXXXXXX", "action": "upiDeclineCollect" } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639167811935", "amount": "5.00", "currency": "INR", "customerPhone": "9876543210", "customer_email": "abc@gmail.com" } // block:end:collectDeclineReqH // block:start:collectDeclineRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "transactionTimestamp": "2021-12-11T02:01:57+05:30", "status": "SUCCESS", "gatewayTransactionId": "XXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Transaction declined", "gatewayResponseCode": "ZA", "gatewayReferenceId": "XXXXXXXX", "customerVpa": "XXXXXXXX@XXXXXXXX", "customerMobileNumber": "XXXXXXXX", "amount": "5.00", "refUrl": "https://www.abcxyz.com/", "action": "upiDeclineCollect" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false, } // block:end:collectDeclineRespH // block:start:blockSpamReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "AXB50298319391657664494011", "signaturePayload": "", "signature": "", "shouldSpam": "false", "merchantKeyId" "1234", "shouldBlock": "true", "payeeVpa": "8809800980@stockaxis", "action": "upiBlockSpam" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:blockSpamReqH // block:start:blockSpamRespH { "service": "in.juspay.hyperapi", "requestId": "93571360-f4bf-406e-9cae-75a21aaf1370", "payload": { "action": "upiBlockSpam", "bn": [...], "status": "SUCCESS", "gatewayResponseMessage": "", "gatewayResponseCode": "00", "responseMessage": "SUCCESS", "responseCode": "SUCCESS " }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:blockSpamRespH // block:start:blockVpaListReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "", "merchantKeyId": "1234", "limit": 100, "offset": 0, "action": "upiBlockedVpaList" } } ``` #### Kotlin Code Snippet: ```kotlin // block:start:listTransactionsReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "GFe…………………..w==", "merchantKeyId": "1234", "limit": "100", "offset": "0", "action": "upiTransactionList", } } "signaturePayload": { "merchant_id": "stock", "timestamp": "1639147293629" "customer_id":"9876543210", } // block:end:listTransactionsReqH // block:start:listTransactionsRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "status": "SUCCESS", "merchantChannelId": "STOCKAPP" "merchantCustomerId": "9876543210" "merchantId": "stock" "txnList": [ { }, { } ], "action": "upiTransactionList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listTransactionsRespH // block:start:transactionStatusReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxnStatus", "signature": "", "signaturePayload": "", "merchantKeyId":"1234", "upiRequestId": "", "transactionType": "CUSTOMER_DEBITED_VIA_PAY", "transactionTimestamp": "1639147293629", "vpa": "abc@xyz", "checkWithUdir":"true", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1639147293629", } // block:end:transactionStatusReqH // block:start:transactionStatusRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "status": "SUCCESS", "udfParameters":"{}", "type":"CUSTOMER_DEBITED_VIA_PAY", "transactionTimestamp":"2016-11-25T00:00:00+05:30", "responseMessage":"SUCCESS", "responseCode":"SUCCESS", "refUrl":"https://www.abcxyz.com/", "payerVpa":"customer@xyz"", "payerMobileNumber":"919812388554", "payerMerchantCustomerId":"DEMO-CUST-1234", "payeeVpa":"customer1@abc", "payeeName":"abc", "payeeMcc":"7322", "merchantRequestId":"22209140384", "merchantId\":"ONECARD", "merchantCustomerId":"2955809234891040000", "maskedAccountNumber":"652912XXXXXXXX29", "gatewayTransactionId":"YJPfd78b8d61ca8472b99ef.....", "gatewayResponseMessage":"Transaction is approved", "gatewayResponseCode":"00", "gatewayReferenceId":"538593539023", "customResponse":"{}", "bankCode":"123456", "bankAccountUniqueId":"fb96f8b2b1ab0c070d0d894", "amount":"4923.00", "action":"upiTxnStatus" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:transactionStatusRespH // block:start:raiseComplaintReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "upiRequestId": "AUT699393106f865d1a9467c59725e6891f", "originalUpiRequestId": "AUT75533106f865d1a9wegrhjw9725e6891f" "adjAmount": "0.50", "adjFlag": "PBRB", "adjCode": "U010", "action": "upiComplaintRaise", "type":"COMPLAINT", "purpose": "00", "refUrl": "https://www.abcxyz.com/", "remarks": "Amount not credited", "signature": "", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:raiseComplaintReqH // block:start:raiseComplaintRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiComplaintRaise", "status": "SUCCESS", "responseCode": "SUCCESS", "responseMessage": "SUCCESS", "complaintRaisePayload": { "payerVpa": "123454306@1234", "payeeVpa": "83746598743@2312", "merchantId": "TEST", "merchantChannelId": "TESTAPP", "merchantCustomerId": "test-merchantcustomer-1", "customerMobileNumber": "919988776655", "merchantRequestId": "3764723469", "transactionAmount": "1.00", "reqAdjAmount": "0.50", "reqAdjFlag": "PBRB", "reqAdjCode": "U010", "crn": "941451534851394", "gatewayReferenceId": "123456", "gatewayComplaintId": "AUT699393106f865d1a9467c59725e6891f", "gatewayResponseCode": "00", "gatewayResponseStatus": "SUCCESS", "gatewayResponseMessage": "Your Complaint is Raised" } }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:raiseComplaintRespH // block:start:listPendingComplaintReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "action": "upiListPendingComplaints", "limit": 100, "offset": 0, "signature": "", "signaturePayload": "", "merchantKeyId": "1234" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:listPendingComplaintReqH // block:start:listPendingComplaintRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiListPendingComplaints", "status": "SUCCESS", "responseCode": "SUCCESS", "responseMessage": "SUCCESS", "merchantId": "stock", "merchantChannelId": "stockAPP", "complaintList": [{ "upiRequestId": "72832032893287", "transactionUpiRequestId": "3764723469", "status": "SUCCESS", "reqAdjFlag": "PBRB", "reqAdjAmount": "0.50", "reqAdjCode": "U010", "remarks": "UPI", "payerVpa": "123454306@1234", "payeeVpa": "83746598743@2312", "orgTxnStatus": "SUCCESS", "orgTxnDate": "16683984398", "crn": "941451534851394", "complaintDate": "16683984398", }] }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listPendingComplaintRespH // block:start:complaintStatusReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "action": "upiComplaintStatus", "originalUpiRequestId": "APL699393106f8sbsbnbnns67c59725e6891f", "originalTransactionUpiRequestId": "APL699393106f865d1a9467c59725e6891f", "signature": "", "signaturePayload": "", "merchantKeyId": "1234" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:complaintStatusReqH // block:start:complaintStatusRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiComplaintStatus" "status": "SUCCESS", "responseMessage": "SUCCESS", "responseCode": "SUCCESS", "complaintStatusPayload": { "merchantChannelId": "stockAPP", "gatewayResponseStatus": "FAILURE", "merchantId": "stock", "gatewayComplaintId": "ICIJP22d737c1b544f7aa55f049ad84497b", "reqAdjAmount": "6600.00", "gatewayResponseMessage": "Transaction failed", "payerVpa": "something@handle", "merchantRequestId": "45f54883f5548ddac7bd4b16bd06e1d", "gatewayResponseCode": "U48", "gatewayReferenceId": "208409676817", "reqAdjCode": "U010", "crn": "UPI22032564889", "customerMobileNumber": "918086332344", "payeeVpa": "something@handle", "reqAdjFlag": "PBRB", "transactionAmount": "1.00", "merchantCustomerId": "090d5030-7d17-11ec-939b-b1ce4bc73875", "adjAmount": "0.50", "adjFlag": "PBRB", "adjCode": "U010", } } "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:complaintStatusRespH // block:start:collectApproveReqH { "service": "in.juspay.hyperapi", "requestId": "96ad03b7-c298-4702-9257-83ce9225485d", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168104341.0", "signaturePayload": "", "signature": "GFetNZC/UQ5hJF+MnaZ1dCD25GSeyFmm2cBY+rIkOhZDnR+icvl95g/1Dx4B9p/KE/ILkyBNOGNO\nDUBnxoaFeqhGE1pP3krWHcD2H2dJSTmcv7BvxeJKMdw==\n", "payeeVpa": "XXXXXXXXXXXXXXXX@XXXXXXXX", "merchantKeyId": "1234", "customerVpa": "XXXXXXXXXXXXXXXX@XXXXXXXX", "amount": "1.00", "accountReferenceId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "action": "upiPayCollect", "clAuthMode": “MPIN"/“BIOMETRICS” } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639167811935", "amount": "5.00", "currency": "INR" } // block:end:collectApproveReqH // block:start:collectApproveRespH { "service": "in.juspay.hyperapi", "requestId": "96ad03b7-c298-4702-9257-83ce9225485d", "payload": { "transactionTimestamp": "2021-12-11T01:54:28+05:30", "status": "SUCCESS", "maskedAccountNumber": "XXXXXXXXXX998898", "gatewayTransactionId": "XXXXXXXXXXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseCode": "00", "gatewayReferenceId": "XXXXXXXXXXXX", "payeeMcc": "0000", "customerVpa": "XXXXXX@XXXXXX", "customerMobileNumber": "XXXXXXXXXXXX", "bankCode": "500007", "bankAccountUniqueId": "XXXXXXXXXXXXXXXXXXXXXXXXX", "amount": "1.00", "refUrl": "https://www.abcxyz.com/", "action": "upiPayCollect", "clAuthMode": “MPIN"/“BIOMETRICS” }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:collectApproveRespH // block:start:collectDeclineReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168319187.0", "signaturePayload": "", "signature": "GF.........\n", "payeeVpa": "XXXXXXXXXX@XXXXXX", "payeeName": "ABC", "merchantKeyId": "1234", "customerVpa": "XXXXXXXXX@XXXXX", "amount": "5.00", "accountReferenceId": "XXXXXXXXXXXXXXXX", "action": "upiDeclineCollect" } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639167811935", "amount": "5.00", "currency": "INR", "customerPhone": "9876543210", "customer_email": "abc@gmail.com" } // block:end:collectDeclineReqH // block:start:collectDeclineRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "transactionTimestamp": "2021-12-11T02:01:57+05:30", "status": "SUCCESS", "gatewayTransactionId": "XXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Transaction declined", "gatewayResponseCode": "ZA", "gatewayReferenceId": "XXXXXXXX", "customerVpa": "XXXXXXXX@XXXXXXXX", "customerMobileNumber": "XXXXXXXX", "amount": "5.00", "refUrl": "https://www.abcxyz.com/", "action": "upiDeclineCollect" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false, } // block:end:collectDeclineRespH // block:start:blockSpamReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "AXB50298319391657664494011", "signaturePayload": "", "signature": "", "shouldSpam": "false", "merchantKeyId" "1234", "shouldBlock": "true", "payeeVpa": "8809800980@stockaxis", "action": "upiBlockSpam" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:blockSpamReqH // block:start:blockSpamRespH { "service": "in.juspay.hyperapi", "requestId": "93571360-f4bf-406e-9cae-75a21aaf1370", "payload": { "action": "upiBlockSpam", "bn": [...], "status": "SUCCESS", "gatewayResponseMessage": "", "gatewayResponseCode": "00", "responseMessage": "SUCCESS", "responseCode": "SUCCESS " }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:blockSpamRespH // block:start:blockVpaListReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "", "merchantKeyId": "1234", "limit": 100, "offset": 0, "action": "upiBlockedVpaList" } } ``` ## Sample Code Snippets: ### Request snippets: #### Request Code Snippet: ```request // block:start:listTransactionsReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "GFe…………………..w==", "merchantKeyId": "1234", "limit": "100", "offset": "0", "action": "upiTransactionList", } } "signaturePayload": { "merchant_id": "stock", "timestamp": "1639147293629" "customer_id":"9876543210", } // block:end:listTransactionsReqH // block:start:listTransactionsRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "status": "SUCCESS", "merchantChannelId": "STOCKAPP" "merchantCustomerId": "9876543210" "merchantId": "stock" "txnList": [ { }, { } ], "action": "upiTransactionList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listTransactionsRespH // block:start:transactionStatusReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxnStatus", "signature": "", "signaturePayload": "", "merchantKeyId":"1234", "upiRequestId": "", "transactionType": "CUSTOMER_DEBITED_VIA_PAY", "transactionTimestamp": "1639147293629", "vpa": "abc@xyz", "checkWithUdir":"true", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1639147293629", } // block:end:transactionStatusReqH // block:start:transactionStatusRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "status": "SUCCESS", "udfParameters":"{}", "type":"CUSTOMER_DEBITED_VIA_PAY", "transactionTimestamp":"2016-11-25T00:00:00+05:30", "responseMessage":"SUCCESS", "responseCode":"SUCCESS", "refUrl":"https://www.abcxyz.com/", "payerVpa":"customer@xyz"", "payerMobileNumber":"919812388554", "payerMerchantCustomerId":"DEMO-CUST-1234", "payeeVpa":"customer1@abc", "payeeName":"abc", "payeeMcc":"7322", "merchantRequestId":"22209140384", "merchantId\":"ONECARD", "merchantCustomerId":"2955809234891040000", "maskedAccountNumber":"652912XXXXXXXX29", "gatewayTransactionId":"YJPfd78b8d61ca8472b99ef.....", "gatewayResponseMessage":"Transaction is approved", "gatewayResponseCode":"00", "gatewayReferenceId":"538593539023", "customResponse":"{}", "bankCode":"123456", "bankAccountUniqueId":"fb96f8b2b1ab0c070d0d894", "amount":"4923.00", "action":"upiTxnStatus" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:transactionStatusRespH // block:start:raiseComplaintReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "upiRequestId": "AUT699393106f865d1a9467c59725e6891f", "originalUpiRequestId": "AUT75533106f865d1a9wegrhjw9725e6891f" "adjAmount": "0.50", "adjFlag": "PBRB", "adjCode": "U010", "action": "upiComplaintRaise", "type":"COMPLAINT", "purpose": "00", "refUrl": "https://www.abcxyz.com/", "remarks": "Amount not credited", "signature": "", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:raiseComplaintReqH // block:start:raiseComplaintRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiComplaintRaise", "status": "SUCCESS", "responseCode": "SUCCESS", "responseMessage": "SUCCESS", "complaintRaisePayload": { "payerVpa": "123454306@1234", "payeeVpa": "83746598743@2312", "merchantId": "TEST", "merchantChannelId": "TESTAPP", "merchantCustomerId": "test-merchantcustomer-1", "customerMobileNumber": "919988776655", "merchantRequestId": "3764723469", "transactionAmount": "1.00", "reqAdjAmount": "0.50", "reqAdjFlag": "PBRB", "reqAdjCode": "U010", "crn": "941451534851394", "gatewayReferenceId": "123456", "gatewayComplaintId": "AUT699393106f865d1a9467c59725e6891f", "gatewayResponseCode": "00", "gatewayResponseStatus": "SUCCESS", "gatewayResponseMessage": "Your Complaint is Raised" } }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:raiseComplaintRespH // block:start:listPendingComplaintReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "action": "upiListPendingComplaints", "limit": 100, "offset": 0, "signature": "", "signaturePayload": "", "merchantKeyId": "1234" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:listPendingComplaintReqH // block:start:listPendingComplaintRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiListPendingComplaints", "status": "SUCCESS", "responseCode": "SUCCESS", "responseMessage": "SUCCESS", "merchantId": "stock", "merchantChannelId": "stockAPP", "complaintList": [{ "upiRequestId": "72832032893287", "transactionUpiRequestId": "3764723469", "status": "SUCCESS", "reqAdjFlag": "PBRB", "reqAdjAmount": "0.50", "reqAdjCode": "U010", "remarks": "UPI", "payerVpa": "123454306@1234", "payeeVpa": "83746598743@2312", "orgTxnStatus": "SUCCESS", "orgTxnDate": "16683984398", "crn": "941451534851394", "complaintDate": "16683984398", }] }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listPendingComplaintRespH // block:start:complaintStatusReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "action": "upiComplaintStatus", "originalUpiRequestId": "APL699393106f8sbsbnbnns67c59725e6891f", "originalTransactionUpiRequestId": "APL699393106f865d1a9467c59725e6891f", "signature": "", "signaturePayload": "", "merchantKeyId": "1234" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:complaintStatusReqH // block:start:complaintStatusRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiComplaintStatus" "status": "SUCCESS", "responseMessage": "SUCCESS", "responseCode": "SUCCESS", "complaintStatusPayload": { "merchantChannelId": "stockAPP", "gatewayResponseStatus": "FAILURE", "merchantId": "stock", "gatewayComplaintId": "ICIJP22d737c1b544f7aa55f049ad84497b", "reqAdjAmount": "6600.00", "gatewayResponseMessage": "Transaction failed", "payerVpa": "something@handle", "merchantRequestId": "45f54883f5548ddac7bd4b16bd06e1d", "gatewayResponseCode": "U48", "gatewayReferenceId": "208409676817", "reqAdjCode": "U010", "crn": "UPI22032564889", "customerMobileNumber": "918086332344", "payeeVpa": "something@handle", "reqAdjFlag": "PBRB", "transactionAmount": "1.00", "merchantCustomerId": "090d5030-7d17-11ec-939b-b1ce4bc73875", "adjAmount": "0.50", "adjFlag": "PBRB", "adjCode": "U010", } } "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:complaintStatusRespH // block:start:collectApproveReqH { "service": "in.juspay.hyperapi", "requestId": "96ad03b7-c298-4702-9257-83ce9225485d", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168104341.0", "signaturePayload": "", "signature": "GFetNZC/UQ5hJF+MnaZ1dCD25GSeyFmm2cBY+rIkOhZDnR+icvl95g/1Dx4B9p/KE/ILkyBNOGNO\nDUBnxoaFeqhGE1pP3krWHcD2H2dJSTmcv7BvxeJKMdw==\n", "payeeVpa": "XXXXXXXXXXXXXXXX@XXXXXXXX", "merchantKeyId": "1234", "customerVpa": "XXXXXXXXXXXXXXXX@XXXXXXXX", "amount": "1.00", "accountReferenceId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "action": "upiPayCollect", "clAuthMode": “MPIN"/“BIOMETRICS” } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639167811935", "amount": "5.00", "currency": "INR" } // block:end:collectApproveReqH // block:start:collectApproveRespH { "service": "in.juspay.hyperapi", "requestId": "96ad03b7-c298-4702-9257-83ce9225485d", "payload": { "transactionTimestamp": "2021-12-11T01:54:28+05:30", "status": "SUCCESS", "maskedAccountNumber": "XXXXXXXXXX998898", "gatewayTransactionId": "XXXXXXXXXXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseCode": "00", "gatewayReferenceId": "XXXXXXXXXXXX", "payeeMcc": "0000", "customerVpa": "XXXXXX@XXXXXX", "customerMobileNumber": "XXXXXXXXXXXX", "bankCode": "500007", "bankAccountUniqueId": "XXXXXXXXXXXXXXXXXXXXXXXXX", "amount": "1.00", "refUrl": "https://www.abcxyz.com/", "action": "upiPayCollect", "clAuthMode": “MPIN"/“BIOMETRICS” }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:collectApproveRespH // block:start:collectDeclineReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168319187.0", "signaturePayload": "", "signature": "GF.........\n", "payeeVpa": "XXXXXXXXXX@XXXXXX", "payeeName": "ABC", "merchantKeyId": "1234", "customerVpa": "XXXXXXXXX@XXXXX", "amount": "5.00", "accountReferenceId": "XXXXXXXXXXXXXXXX", "action": "upiDeclineCollect" } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639167811935", "amount": "5.00", "currency": "INR", "customerPhone": "9876543210", "customer_email": "abc@gmail.com" } // block:end:collectDeclineReqH // block:start:collectDeclineRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "transactionTimestamp": "2021-12-11T02:01:57+05:30", "status": "SUCCESS", "gatewayTransactionId": "XXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Transaction declined", "gatewayResponseCode": "ZA", "gatewayReferenceId": "XXXXXXXX", "customerVpa": "XXXXXXXX@XXXXXXXX", "customerMobileNumber": "XXXXXXXX", "amount": "5.00", "refUrl": "https://www.abcxyz.com/", "action": "upiDeclineCollect" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false, } // block:end:collectDeclineRespH // block:start:blockSpamReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "AXB50298319391657664494011", "signaturePayload": "", "signature": "", "shouldSpam": "false", "merchantKeyId" "1234", "shouldBlock": "true", "payeeVpa": "8809800980@stockaxis", "action": "upiBlockSpam" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:blockSpamReqH // block:start:blockSpamRespH { "service": "in.juspay.hyperapi", "requestId": "93571360-f4bf-406e-9cae-75a21aaf1370", "payload": { "action": "upiBlockSpam", "bn": [...], "status": "SUCCESS", "gatewayResponseMessage": "", "gatewayResponseCode": "00", "responseMessage": "SUCCESS", "responseCode": "SUCCESS " }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:blockSpamRespH // block:start:blockVpaListReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "", "merchantKeyId": "1234", "limit": 100, "offset": 0, "action": "upiBlockedVpaList" } } ``` ### Response snippets: #### Response: ```plaintext // block:start:blockVpaListRespH { "service": "in.juspay.hyperapi", "requestId": "621e5bc9-a06a-4593-a16a-1be7d01d1cac", "payload": { "status": "SUCCESS", "merchantChannelId": "stock", "merchantCustomerId": "8002019282", "blockedVpas": [ { "payeeVpa": "abc@xyz", "name": "ABC", "blockedAt": "2022-01-21T09:23:56+05:30" }, { …. } ], "action": "upiBlockedVpaList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:blockVpaListRespH // block:start:unblockReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "", "merchantKeyId": "1234", "payeeVpa": "abc@xyz", "action": "upiUnblockVpa" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:unblockReqH // block:start:unblockRespH { "service": "in.juspay.hyperapi", "requestId": "93571360-f4bf-406e-9cae-75a21aaf1370", "payload": { "status": "SUCCESS", "merchantChannelId": "stock", "merchantId": "stock", "merchantCustomerId": "9876543210", "payeeVpa": "abc@xyz" "action": "upiUnblockVpa", }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:unblockRespH // block:start:p2mCreateMandateReqH { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "shouldCreateMandate": true, "orderId": "hyperorder87647", "accountRefId": "ABC123456789", "showConfirmation": false, "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "1234567891", "timestamp": "1656567708646", "order_id": "hyperorder87647", "mandateName": "ABC", "mandateMaxAmount": "1000.00", "mandateAmountRule": "VARIABLE", "mandateFrequency": "MONTHLY", "mandateStartDate": "1656567708", "mandateEndDate": "1704997800", "mandateRuleType": "ON", "mandateRuleValue": "1", "mandateBlockFunds": true, "metadata.:gateway_reference_id" : "ABC123", "amount": "1000.00" } // block:end:p2mCreateMandateReqH // block:start:p2mCreateMandateRespH { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "txnUuid": "mozkn8bEui8KqwGCUjG", "status": "SUCCESS", "selectedAccount": { "vpa": "7604041111@ypay", "account": { "type": "SAVINGS", "referenceId": "A8ebeab40.....fa2dc8071d102", "name": "ABC", "mpinSet": "true", "maskedAccountNumber": "XXXXXXXXXX254769", "isPrimary": "false", "ifsc": "AABF0008032", "branchName": "", "bankName": "Mypsp2", "bankCode": "500004", "bankAccountHash": "fejgfvhef67t987" } }, "orderId": "hyperorder87647", "mutualFundDetails": null, "mandate": { "validityStart": "2023/10/31", "validityEnd": "2023/12/31", "umn": "1e8195d8281.......c0f332f62c8e1@ypay", "transactionType": "P2M_MANDATE", "shareToPayee": "true", "role": "PAYER", "remarks": "No Remarks", "refUrl": "https://www.juspay.com/", "recurrenceValue": "1", "recurrenceRule": "ON", "recurrencePattern": "MONTHLY", "payerVpa": "7604041111@ypay", "payerRevocable": "true", "payerName": "XYZ", "payeeVpa": "abc@jpay", "payeeName": "ABCUAT", "payeeMcc": "1520", "orgMandateId": "YJP11gsqszvouf.........8bEAj2KqwGCUjG", "mandateTimestamp": "2023-10-31T18:32:13+05:30", "mandateName": "ABC", "initiatedBy": "PAYER", "gatewayResponseStatus": "SUCCESS", "gatewayResponseMessage": "Mandate Creation Success", "gatewayResponseCode": "00", "gatewayReferenceId": "367032389753", "gatewayMandateId": "YJP11gsqszvouf.........8bEAj2KqwGCUjG", "expiry": "40", "blockFund": "false", "amountRule": "VARIABLE", "amount": "10.00" }, "action": "upiTxn", "accountRefId": "A8ebeab40b......8fa2dc8071d102" }, "errorMessage": "", "errorCode": "", "error": false } // block:end:p2mCreateMandateRespH // block:start:listMandateReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "GFe…………………..w==\n", "merchantKeyId": "1234", "status": "PENDING", "limit": "100", "offset": "0", "action": "upiListMandate" } } "signaturePayload": { "merchant_id": "XXXXXXXX", "customer_id": "XXXXXXXX", "timestamp": "1639167811935" } // block:end:listMandateReqH // block:start:listMandateRespH { "service": "in.juspay.hyperapi", "requestId": "621e5bc9-a06a-4593-a16a-1be7d01d1cac", "payload": { "status": "SUCCESS", "responseMessage": "SUCCESS", "responseCode": "SUCCESS", "mandateList": [ { < Mandate Payload > }, { < Mandate Payload > } ... ], "action": "upiListMandate", "refUrl": "https://www.abcxyz.com/" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listMandateRespH // block:start:updateRevokeMandateReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168319187.0", "signaturePayload": "", "signature": "GFe…………………..w==\n", "merchantKeyId": "1234", "orgMandateId": "XXXXXXXXXXXXXXXXXXXXXXX", "payeeVpa": "XXXXXXXXXX@XXXXXX", "payerVpa": "XXXXXXXXXX@XXXXXX", "payeeName": "ABC", "refUrl": "https://www.abcxyz.com/", "requestType": "REVOKE", "amount": "5.00", "initiatedBy": "PAYER", "accountReferenceId": "XXXXXXXXXXXXXXXX", "action": "upiUpdateRevokeMandate" } } "signaturePayload": { "merchant_id": "XXXXXXXX", "customer_id": "XXXXXXXX", "timestamp": "1639167811935" } // block:end:updateRevokeMandateReqH // block:start:updateRevokeMandateRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "status": "SUCCESS", "responseMessage": "Transaction successful", "responseCode": "00", "mandatePayload": { ... }, "action": "upiUpdateRevokeMandate" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:updateRevokeMandateRespH // block:start:pauseUnpauseMandateReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168319187.0", "signaturePayload": "", "signature": "GFe…………………..w==\n", "merchantKeyId": "1234", "orgMandateId": "XXXXXXXXXXXXXXXXXXXXXXX", "payeeVpa": "XXXXXXXXXX@XXXXXX", "payerVpa": "XXXXXXXXXX@XXXXXX", "payerName": "ABC", "requestType": "UNPAUSE", "amount": "5.00", "accountReferenceId": "XXXXXXXXXXXXXXXX", "action": "upiPauseUnpauseMandate" "payeeName": "ABCD", } } "signaturePayload": { "merchant_id": "XXXXXXXX", "customer_id": "XXXXXXXX", "timestamp": "1639167811935", "amount": "5.00", "currency": "INR" } // block:end:pauseUnpauseMandateReqH // block:start:pauseUnpauseMandateRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "status": "SUCCESS", "responseMessage": "Transaction successful", "responseCode": "00", "mandatePayload": { ... }, "action": "upiPauseUnpauseMandate" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:pauseUnpauseMandateRespH // block:start:approveDeclineMandateH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "timestamp": "1639168319187.0", "signaturePayload": "", "signature": "GFe…………………..w==\n", "payeeVpa": "XXXXXXXXXX@XXXXXX", "payerVpa": "XXXXXXXXXX@XXXXXX", "payeeName": "ABC" "merchantKeyId": "1234", "mandateRequestId": "XXXXXXXXXXXXXXXXXXXXXXX", "merchantRequestId": "XXXXXXXXXXXXXXXXXXXXXX", "requestType": "APPROVE", "amount": "5.00", "accountReferenceId": "XXXXXXXXXXXXXXXX", "action": "upiApproveDeclineMandate" } } "signaturePayload": { "merchant_id": "XXXXXXXX", "customer_id": "XXXXXXXX", "timestamp": "1639167811935" } // block:end:approveDeclineMandateH // block:start:approveDeclineMandateOutputH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "status": "SUCCESS", "responseMessage": "Transaction successful", "responseCode": "00", "mandatePayload": { ... }, "action": "upiApproveDeclineMandete" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:approveDeclineMandateOutputH // block:start:checkMandateStatusReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "GFe…………………..w==\n", "merchantKeyId": "4794", “role” : “”, “orgMandateId”: “XXXXXXXXXXXXXXXXXXXXXXX”, "action": "upiCheckMandateStatus" } } "signaturePayload": { "merchant_id": "XXXXXXXX", "customer_id": "XXXXXXXX", "timestamp": "1639167811935" } // block:end:checkMandateStatusReqH // block:start:checkMandateStatusRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "status": "SUCCESS", "responseMessage": "Transaction successful", "responseCode": "00", "mandatePayload": {...}, "action": "upiCheckMandateStatus" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:checkMandateStatusRespH // block:start:deleteVpaReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "action": "upiDeleteVpa", "customerPrimaryVpa": "8809800980@stockaxis", "customerVpa": "abc0980@stockaxis", "merchantKeyId": "1234", "signaturePayload": "", "signature": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:deleteVpaReqH // block:start:sendMoneyRespH { "service": "in.juspay.hyperapi", "requestId": "f9432fad-a575-451a-956c-3369a6ff6b01", "payload": { "transactionTimestamp": "2021-12-11T02:11:46+05:30", "status": "SUCCESS", "payType": "P2P_PAY", "maskedAccountNumber": "XXXXXXXXXX998898", "gatewayTransactionId": "ABCD12367", "gatewayResponseMessage": "SUCCESS", "gatewayResponseCode": "00", "gatewayReferenceId": "134420747893", "customerVpa": "wkr@xyz", "customerMobileNumber": "5678898", "bankCode": "500007", "bankAccountUniqueId": "082eedaa58700e492179e97841584ab8d39a4cff9275ef8ee9bc59f9186d3d68", "amount": "5.00", "action": "upiSendMoney", "clAuthMode": “MPIN"/“BIOMETRICS”, "refUrl": "www.google.com" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:sendMoneyRespH ``` --- ## Complete Code Reference The following code files are referenced in the steps above: ### InappHeadless2.txt ``` // block:start:listTransactionsReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "GFe…………………..w==", "merchantKeyId": "1234", "limit": "100", "offset": "0", "action": "upiTransactionList", } } "signaturePayload": { "merchant_id": "stock", "timestamp": "1639147293629" "customer_id":"9876543210", } // block:end:listTransactionsReqH // block:start:listTransactionsRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "status": "SUCCESS", "merchantChannelId": "STOCKAPP" "merchantCustomerId": "9876543210" "merchantId": "stock" "txnList": [ { }, { } ], "action": "upiTransactionList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listTransactionsRespH // block:start:transactionStatusReqH { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxnStatus", "signature": "", "signaturePayload": "", "merchantKeyId":"1234", "upiRequestId": "", "transactionType": "CUSTOMER_DEBITED_VIA_PAY", "transactionTimestamp": "1639147293629", "vpa": "abc@xyz", "checkWithUdir":"true", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1639147293629", } // block:end:transactionStatusReqH // block:start:transactionStatusRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "status": "SUCCESS", "udfParameters":"{}", "type":"CUSTOMER_DEBITED_VIA_PAY", "transactionTimestamp":"2016-11-25T00:00:00+05:30", "responseMessage":"SUCCESS", "responseCode":"SUCCESS", "refUrl":"https://www.abcxyz.com/", "payerVpa":"customer@xyz"", "payerMobileNumber":"919812388554", "payerMerchantCustomerId":"DEMO-CUST-1234", "payeeVpa":"customer1@abc", "payeeName":"abc", "payeeMcc":"7322", "merchantRequestId":"22209140384", "merchantId\":"ONECARD", "merchantCustomerId":"2955809234891040000", "maskedAccountNumber":"652912XXXXXXXX29", "gatewayTransactionId":"YJPfd78b8d61ca8472b99ef.....", "gatewayResponseMessage":"Transaction is approved", "gatewayResponseCode":"00", "gatewayReferenceId":"538593539023", "customResponse":"{}", "bankCode":"123456", "bankAccountUniqueId":"fb96f8b2b1ab0c070d0d894", "amount":"4923.00", "action":"upiTxnStatus" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:transactionStatusRespH // block:start:raiseComplaintReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "upiRequestId": "AUT699393106f865d1a9467c59725e6891f", "originalUpiRequestId": "AUT75533106f865d1a9wegrhjw9725e6891f" "adjAmount": "0.50", "adjFlag": "PBRB", "adjCode": "U010", "action": "upiComplaintRaise", "type":"COMPLAINT", "purpose": "00", "refUrl": "https://www.abcxyz.com/", "remarks": "Amount not credited", "signature": "", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:raiseComplaintReqH // block:start:raiseComplaintRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiComplaintRaise", "status": "SUCCESS", "responseCode": "SUCCESS", "responseMessage": "SUCCESS", "complaintRaisePayload": { "payerVpa": "123454306@1234", "payeeVpa": "83746598743@2312", "merchantId": "TEST", "merchantChannelId": "TESTAPP", "merchantCustomerId": "test-merchantcustomer-1", "customerMobileNumber": "919988776655", "merchantRequestId": "3764723469", "transactionAmount": "1.00", "reqAdjAmount": "0.50", "reqAdjFlag": "PBRB", "reqAdjCode": "U010", "crn": "941451534851394", "gatewayReferenceId": "123456", "gatewayComplaintId": "AUT699393106f865d1a9467c59725e6891f", "gatewayResponseCode": "00", "gatewayResponseStatus": "SUCCESS", "gatewayResponseMessage": "Your Complaint is Raised" } }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:raiseComplaintRespH // block:start:listPendingComplaintReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "action": "upiListPendingComplaints", "limit": 100, "offset": 0, "signature": "", "signaturePayload": "", "merchantKeyId": "1234" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:listPendingComplaintReqH // block:start:listPendingComplaintRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiListPendingComplaints", "status": "SUCCESS", "responseCode": "SUCCESS", "responseMessage": "SUCCESS", "merchantId": "stock", "merchantChannelId": "stockAPP", "complaintList": [{ "upiRequestId": "72832032893287", "transactionUpiRequestId": "3764723469", "status": "SUCCESS", "reqAdjFlag": "PBRB", "reqAdjAmount": "0.50", "reqAdjCode": "U010", "remarks": "UPI", "payerVpa": "123454306@1234", "payeeVpa": "83746598743@2312", "orgTxnStatus": "SUCCESS", "orgTxnDate": "16683984398", "crn": "941451534851394", "complaintDate": "16683984398", }] }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:listPendingComplaintRespH // block:start:complaintStatusReqH { "service": "in.juspay.hyperapi", "requestId": "095fa47e-b528-457d-8310-faece4c37814", "payload": { "action": "upiComplaintStatus", "originalUpiRequestId": "APL699393106f8sbsbnbnns67c59725e6891f", "originalTransactionUpiRequestId": "APL699393106f865d1a9467c59725e6891f", "signature": "", "signaturePayload": "", "merchantKeyId": "1234" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:complaintStatusReqH // block:start:complaintStatusRespH { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "action": "upiComplaintStatus" "status": "SUCCESS", "responseMessage": "SUCCESS", "responseCode": "SUCCESS", "complaintStatusPayload": { "merchantChannelId": "stockAPP", "gatewayResponseStatus": "FAILURE", "merchantId": "stock", "gatewayComplaintId": "ICIJP22d737c1b544f7aa55f049ad84497b", "reqAdjAmount": "6600.00", "gatewayResponseMessage": "Transaction failed", "payerVpa": "something@handle", "merchantRequestId": "45f54883f5548ddac7bd4b16bd06e1d", "gatewayResponseCode": "U48", "gatewayReferenceId": "208409676817", "reqAdjCode": "U010", "crn": "UPI22032564889", "customerMobileNumber": "918086332344", "payeeVpa": "something@handle", "reqAdjFlag": "PBRB", "transactionAmount": "1.00", "merchantCustomerId": "090d5030-7d17-11ec-939b-b1ce4bc73875", "adjAmount": "0.50", "adjFlag": "PBRB", "adjCode": "U010", } } "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:complaintStatusRespH // block:start:collectApproveReqH { "service": "in.juspay.hyperapi", "requestId": "96ad03b7-c298-4702-9257-83ce9225485d", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168104341.0", "signaturePayload": "", "signature": "GFetNZC/UQ5hJF+MnaZ1dCD25GSeyFmm2cBY+rIkOhZDnR+icvl95g/1Dx4B9p/KE/ILkyBNOGNO\nDUBnxoaFeqhGE1pP3krWHcD2H2dJSTmcv7BvxeJKMdw==\n", "payeeVpa": "XXXXXXXXXXXXXXXX@XXXXXXXX", "merchantKeyId": "1234", "customerVpa": "XXXXXXXXXXXXXXXX@XXXXXXXX", "amount": "1.00", "accountReferenceId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "action": "upiPayCollect", "clAuthMode": “MPIN"/“BIOMETRICS” } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639167811935", "amount": "5.00", "currency": "INR" } // block:end:collectApproveReqH // block:start:collectApproveRespH { "service": "in.juspay.hyperapi", "requestId": "96ad03b7-c298-4702-9257-83ce9225485d", "payload": { "transactionTimestamp": "2021-12-11T01:54:28+05:30", "status": "SUCCESS", "maskedAccountNumber": "XXXXXXXXXX998898", "gatewayTransactionId": "XXXXXXXXXXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseCode": "00", "gatewayReferenceId": "XXXXXXXXXXXX", "payeeMcc": "0000", "customerVpa": "XXXXXX@XXXXXX", "customerMobileNumber": "XXXXXXXXXXXX", "bankCode": "500007", "bankAccountUniqueId": "XXXXXXXXXXXXXXXXXXXXXXXXX", "amount": "1.00", "refUrl": "https://www.abcxyz.com/", "action": "upiPayCollect", "clAuthMode": “MPIN"/“BIOMETRICS” }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:collectApproveRespH // block:start:collectDeclineReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "XXXXXXXXXXXXXXXXXXXXXXXX", "timestamp": "1639168319187.0", "signaturePayload": "", "signature": "GF.........\n", "payeeVpa": "XXXXXXXXXX@XXXXXX", "payeeName": "ABC", "merchantKeyId": "1234", "customerVpa": "XXXXXXXXX@XXXXX", "amount": "5.00", "accountReferenceId": "XXXXXXXXXXXXXXXX", "action": "upiDeclineCollect" } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639167811935", "amount": "5.00", "currency": "INR", "customerPhone": "9876543210", "customer_email": "abc@gmail.com" } // block:end:collectDeclineReqH // block:start:collectDeclineRespH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "transactionTimestamp": "2021-12-11T02:01:57+05:30", "status": "SUCCESS", "gatewayTransactionId": "XXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Transaction declined", "gatewayResponseCode": "ZA", "gatewayReferenceId": "XXXXXXXX", "customerVpa": "XXXXXXXX@XXXXXXXX", "customerMobileNumber": "XXXXXXXX", "amount": "5.00", "refUrl": "https://www.abcxyz.com/", "action": "upiDeclineCollect" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false, } // block:end:collectDeclineRespH // block:start:blockSpamReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "upiRequestId": "AXB50298319391657664494011", "signaturePayload": "", "signature": "", "shouldSpam": "false", "merchantKeyId" "1234", "shouldBlock": "true", "payeeVpa": "8809800980@stockaxis", "action": "upiBlockSpam" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } // block:end:blockSpamReqH // block:start:blockSpamRespH { "service": "in.juspay.hyperapi", "requestId": "93571360-f4bf-406e-9cae-75a21aaf1370", "payload": { "action": "upiBlockSpam", "bn": [...], "status": "SUCCESS", "gatewayResponseMessage": "", "gatewayResponseCode": "00", "responseMessage": "SUCCESS", "responseCode": "SUCCESS " }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:blockSpamRespH // block:start:blockVpaListReqH { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "signaturePayload": "", "signature": "", "merchantKeyId": "1234", "limit": 100, "offset": 0, "action": "upiBlockedVpaList" } } ``` --- ## See Also - [Delete Vpa](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/delete-vpa) - [Delete Account](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/delete-account)