--- page_title: Check Mandate Status product: UPI TPAP SDK platform: Android page_source: https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/check-mandate-status llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt --- ## Check Mandate Status This api will be used for getting mandate status. ### Process Parameters ## Request Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: Example: abcd-12345-abcd-12345 - Tags: String, Mandatory - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String, Mandatory - **Payload**: - Description: Parameters required to call Hyper SDK API - Value: - **Action**: - Description: Operation to be performed in the SDK. Should be upiCheckMandateStatus for this call. - Value: upiCheckMandateStatus - Tags: String, Mandatory - **Role**: - Description: Defines the role of the customer in the mandate PAYER / PAYEE - Tags: String, Mandatory - **MerchantKeyId**: - Description: Key ID to identify the public-private key pair used for signature generation. - Tags: String, Mandatory - **OrgMandateId**: - Description: gatewayMandateId returned during create mandate - Tags: String, Mandatory - **Signature**: - Description: Signature generated for the signaturePayload. - Tags: String, Mandatory - **SignaturePayload**: - Description: Signature payload is a stringified JSON of the details mentioned in the below table. - Value: - **Merchant_id**: - Description: Unique identifier associated with an account created by juspay.Ex: stock - Tags: String, Mandatory - **Customer_id**: - Description: Any unique reference associated with your customer. - Tags: String, Mandatory - **Timestamp**: - Description: Time when request is created in milliseconds. - Tags: String, Mandatory - Tags: String, Mandatory - 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: Value: upiCheckMandateStatus - Value: Operation to be performed in the SDK. - Tags: String, Mandatory - **Status**: - Description: Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE - Tags: String, Mandatory - **ResponseCode**: - Description: Response code returned by gateway for the mandate Operation. - Tags: String, Mandatory - **ResponseMessage**: - Description: Response message returned by gateway for the mandate Operation. - Tags: String, Mandatory - **MandatePayload**: - Description: Contains relevant mandate data - Value: - **AccountReferenceId**: - Description: reference id for selected accounts - Tags: String, Mandatory - **Amount**: - Description: Amount for which merchant requested the mandate. Numeric String with two decimals - Value: eg. 25.00 - Tags: String, Mandatory - **AmountRule**: - Description: Rule on Mandate Amount. If amountRule is MAX, then mandate can be executed for amount less than or equal to the passed amount . If amountRule is EXACT, then mandate should always be executed for the same amount. - Value: MAX / EXACT - Tags: String, Mandatory - **BankAccountUniqueId**: - Description: Unique Identifier for bank account across banks - Tags: String, Mandatory - **BlockFund**: - Description: Denotes whether customer's fund should be blocked or not. Only applicable for ONETIME mandate. For recurring mandate it should always be false, for onetime it can be true or false. Default value is false. - Tags: String, Mandatory - **Expiry**: - Description: Minutes for which request is valid - Tags: String, Optional - **GatewayMandateId**: - Description: UPI request id returned by gateway for the mandate - Tags: String, Mandate - **GatewayReferenceId**: - Description: Unique Transaction Number - Tags: String, Mandatory - **GatewayResponseCode**: - Description: Response code returned by gateway for the transaction. - Tags: String, Mandate - **GatewayResponseMessage**: - Description: Response message returned by gateway for the transaction. - Tags: String, Mandatory - **GatewayResponseStatus**: - Description: Response status returned by gateway. - Tags: String, Mandatory - **InitiatedBy**: - Description: Who has created this update/revoke request. Possible values :- PAYER / PAYEE - Value: Possible values :- PAYER / PAYEE - Tags: String, Madatory - **MandateApprovalTimeStamp**: - Tags: String, Optional - **MandateName**: - Description: Name of the mandate, Helps with differentiation of all mandates - Tags: String, Optional - **MandateTimestamp**: - Description: Timestamp of when the webMandate was initiated - Tags: String, Mandatory - **MandateType**: - Tags: String, Optional - **MerchantCustomerId**: - Description: Merchant generated unique profile id for customer as passed in the request - Tags: String, Mandatory - **MerchantRequestId**: - Description: 35 character alphanumeric unique id. - Tags: String, Mandatory - **OrgMandateId**: - Description: gatewayMandateId returned during create mandate - Tags: String, Mandatory - **PauseEnd**: - Tags: String, Optional - **PauseStart**: - Tags: String, Optional - **PayeeMcc**: - Tags: String, Mandatory - **PayeeName**: - Tags: String, Optional - **PayeeVpa**: - Tags: String, Mandatory - **PayerName**: - Tags: String, Optional - **PayerRevocable**: - Description: Defines whether mandate is revocable by PAYER or not. For onetime mandate it can be true or false. Default value is true. - Value: true/false - Tags: String, Mandatory - **PayerVpa**: - Tags: String, Mandatory - **RecurrencePattern**: - Description: Recurrence Pattern for Mandate - Tags: String, Mandatory - **RecurrenceRule**: - Description: Recurrence Rule for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern. - Tags: String, Optional - **RecurrenceValue**: - Description: Recurrence Value for Mandate. It will not be present for ONETIME, DAILY and ASPRESENTED recurrence pattern. - Tags: String, Optional - **RefUrl**: - Description: Reference url for the mandate. It will be same value if passed in request else it will be a default url. - Tags: String, Optional - **Remarks**: - Description: Any mandate summary. If pased in request, it will be same in response else a default value is send. - Tags: String, Mandatory - **Role**: - Description: Role of the customer for this mandate. - Value: PAYER / PAYEE - Tags: String, Mandatory - **ShareToPayee**: - Description: Describes whether the mandate will be shared with the payee or not. Default value is true. - Value: true/false - Tags: String, Mandatory - **TransactionType**: - Description: Type of Mandate Creation. - Tags: String, Mandatory - **Umn**: - Tags: String, Optional - **ValidityStart**: - Description: Date after which mandate can be executed - Tags: String, Mandatory - **ValidityEnd**: - Description: String with proper date format YYYY/MM/DD - Tags: String, Mandatory - **RefCategory**: - Description: Details for refUrl, whether it is 01 (advertisement), 02(Invoice). If nothing is passed, a default value of `00` is set up and same will be sent back in response. - Tags: String, Optional - **TransactionReference**: - Tags: String, Optional - **Purpose**: - Description: Defines the purpose code of the mandate - Tags: String, Optional - **InitiationMode**: - Description: Defines the initiationMode of the mandate - Tags: String, Optional - Tags: JSON, Mandatory - **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 { "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" } ``` #### Kotlin Code Snippet: ```kotlin { "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" } ``` ## Sample Code Snippets: ### Request snippets: #### Request Code Snippet: ```request // 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 ``` ### 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: ### InappHeadless3.txt ``` // 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 ``` --- ## See Also - [Approve Decline Mandate](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/approve-decline-mandate-) - [Mandate transaction List](https://juspay.io/in/docs/upi-tpap-sdk/android/headless-process-payloads/mandate-transaction-list)