--- page_title: UPI Management product: UPI Plugin SDK platform: iOS page_source: https://juspay.io/in/docs/upi-plugin-sdk/ios/process-payloads/upi-management llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/upi-plugin-sdk/llms.txt --- ## UPI Profile Management This operation supports all UPI Profile management features. ### Process Parameters - Signature Support ## 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 to open the management screen. - Value: value: management - Tags: String, Mandatory - **MerchantKeyId**: - Description: Key ID to identify the public-private key pair used for signature generation. - Value: Example: 1234 - 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. - Value: Example: stock - Tags: String, Mandatory - **Customer_id**: - Description: Any unique reference associated with your customer. - Value: Example: abcde12345 - Tags: String, Mandatory - **Timestamp**: - Description: Time when request is created in milliseconds. - Value: Example: 1665996901100 - Tags: String, Mandatory - **Customer_mobile_number**: - Description: 12 digit mobile number to be passed (with 91 prefix). To be passed when issuing PSP is BHIM or when device binding has to be limited to a particular mobile number. - Tags: String, Conditional - Tags: String, Mandatory - Tags: JSON, Mandatory - **ShouldExitOnDeregister**: - Description: This key needs to be passed to exit the user from the sdk flow after delinking. - Value: Example: True/False - Tags: Boolean, optional ## Response Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: Example: abcd-12345-abcd-12345 - Tags: String - **Service**: - Description: value: in.juspay.hyperapi - Tags: String - **Payload**: - Description: Response Parameters - Value: - **Action**: - Description: Operation performed in the SDK. - Value: value: management - Tags: String - **Status**: - Description: Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE - Value: Example: SUCEESS - Tags: String - Tags: JSON - **Error**: - Description: Possible values :- true/false - Tags: Boolean - **ErrorMessage**: - Description: Error Message - Tags: String - **ErrorCode**: - Description: Error Code - Tags: String - **Event**: - Description: value: process_result - Tags: String #### Code Snippets: - #### Java Code Snippet: ```java { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action": "management", "merchantKeyId": "", "signature": "", "signaturePayload": "", "shouldExitOnDeregister" : "true" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } ``` #### Kotlin Code Snippet: ```kotlin { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action": "management", "merchantKeyId": "", "signature": "", "signaturePayload": "", "shouldExitOnDeregister" : "true" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } ``` ### Process Parameters - ClientAuthToken Support ## Request Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: $requestId - 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 to open the management screen. - Value: value: management - Tags: String, Mandatory - **MerchantId**: - Description: Unique identifier associated with an account created by juspay. - Value: Example: stock - Tags: String, Mandatory - **CustomerId**: - Description: Any unique reference associated with your customer. - Value: Example: abcde12345 - Tags: String, Mandatory - **ClientAuthToken**: - Description: clientAuthToken - Value: Example: tkn_2p2k1b6d26eg4740b9ef01294d3a43b4 - Tags: String, Mandatory - **AuthExpiry**: - Description: Default 15min (functionality to be extended if configuration to change signature expiry is added) - Value: Example: 2021-07-19T07:20:53.318Z - Tags: String, Optional - Tags: JSON, Mandatory - **ShouldExitOnDeregister**: - Description: This key needs to be passed to exit the user from the sdk flow after delinking. - Value: Example: True/False - Tags: Boolean, optional ## Response Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: Example: abcd-12345-abcd-12345 - Tags: String - **Service**: - Description: value: in.juspay.hyperapi - Tags: String - **Payload**: - Description: Response Parameters - Value: - **Action**: - Description: Operation performed in the SDK. - Value: value: management - Tags: String - **Status**: - Description: Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE - Value: Example: SUCEESS - Tags: String - Tags: JSON - **Error**: - Description: Possible values :- true/false - Tags: Boolean - **ErrorMessage**: - Description: Error Message - Tags: String - **ErrorCode**: - Description: Error Code - Tags: String - **Event**: - Description: value: process_result - Tags: String #### Code Snippets: - #### Java Code Snippet: ```java { "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a", "service": "in.juspay.hyperapi", "payload": { "action": "management", "merchantId": "stock", "customerId": "abcde12345", "clientAuthToken": "", "authExpiry" : "2023-07-19T14:15:40Z", "shouldExitOnDeregister": "true" } } ``` #### Kotlin Code Snippet: ```kotlin { "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a", "service": "in.juspay.hyperapi", "payload": { "action": "management", "merchantId": "stock", "customerId": "abcde12345", "clientAuthToken": "", "authExpiry" : "2023-07-19T14:15:40Z", "shouldExitOnDeregister": "true" } } ``` --- ## Complete Code Reference The following code files are referenced in the steps above: ### ClientAuth.txt ``` // block:start:clientAuthTokenPayload { "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a", "service": "in.juspay.hyperapi", "payload": { ... "clientAuthToken": "" ... } } // block:end:clientAuthTokenPayload // block:start:initiate-payloadClientAuth { "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a", "service": "in.juspay.hyperapi", "payload": { "action": "initiate", "clientId": "", "environment": "sandbox", "merchantLoader": false, "clientAuthToken": "", "authExpiry" : "2023-07-19T14:15:40Z", "shouldCreateCustomer": true, "merchantId": "stock", "issuingPsp": "YES_BIZ", "customerId": "abcde12345", } } // block:end:initiate-payloadClientAuth // block:start:initiate-payloadClientAuthResp { "requestId": "", "service": "in.juspay.hyperapi", "payload": { "action": "initiate", "status": "SUCCESS/FAILURE", }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:initiate-payloadClientAuthResp // block:start:getSessionTokenClientAuthReq { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "clientAuthToken": "", "authExpiry" : "2023-07-19T14:15:40Z", "merchantId": "stock", "customerId": "abcde12345", } } // block:end:getSessionTokenClientAuthReq // block:start:getSessionTokenClientAuthResp { "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b", "service": "in.juspay.hyperapi", "payload": { "action": "upiGetSessionToken", "status": "LINKED", "isDeviceBound": "true", "isDeviceActivated": "true", "vpaAccounts": [{ "account": { "bankCode": "11111", "bankName": "ABCD", "maskedAccountNumber": "XXXX203891", "mpinLength": "6", "mpinSet": "true", "referenceId": "A0760cb548bb4dda9d32e3030863dd5", "isInitialTopUpDone": "true", //In case of UPI lite, "isPrimary": "true", "otpLength": "6", "atmPinLength": "6" }, "vpa": "abc@xyz", }], "prefix": "XYZ" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:getSessionTokenClientAuthResp // block:start:onboardingAndPayClientAuthReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "customerMobileNumber" : "9876879867", "clientAuthToken": "", "paymentMethod": "UPI_INAPP", "authExpiry" : "2023-07-19T14:15:40Z", "merchantId": "stock", "customerId": "abcde12345", "amount": "2.00", "accountRefId": "", "showStatusScreen" : "true/false" "orderId": "ABC1234567890" } } // block:end:onboardingAndPayClientAuthReq // block:start:onboardingAndPayClientAuthResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "payload": { "action": "onboardingAndPay", "txnUuid": "mozoghi9Z6PsanCGWK1V", "selectedAccount": { "vpa": "abc@xyz", "account": { "ifsc": "ABCD0000011", "mpinSet": "true", "bankCode": "123456", "referenceId": "A621542c281c4a20b8faf0ee1cb75d", "maskedAccountNumber": "XXXXXXX20000", "isPrimary": "true", "bankName": "Mybank" } }, "orderId": "ABCDE12345", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:onboardingAndPayClientAuthResp // block:start:managementClientAuthReq { "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a", "service": "in.juspay.hyperapi", "payload": { "action": "management", "merchantId": "stock", "customerId": "abcde12345", "clientAuthToken": "", "authExpiry" : "2023-07-19T14:15:40Z", "shouldExitOnDeregister": "true" } } // block:end:managementClientAuthReq // block:start:managementClienttAuthResp { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperupi", "payload": { "action": "management", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:managementClientAuthResp // block:start:upiUiScanPayClientAuthReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "merchantid": "stock", "customerid": "abcde12345", "clientAuthToken": "" "authExpiry" : "2023-07-19T14:15:40Z", "showStatusScreen" : "true/false" } } // block:end:upiUiScanPayClientAuthReq / block:start:upiUiScanPayClientAuthResp { "service": "in.juspay.hyperapi", "requestId": "d0c1d85e-c954-4758-9701-bfa69dd33239", "payload": { "status": "Successful", "gatewayTransactionId": "AXB4e3459e929a6464d8a37c47e9e52b7c1", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseCode": "00", "actionPerformed": "Pay", "action": "upiUiScanPay", "accountReferenceId": "Aa6c1763d28a406e8c2d7fbe23fcc1", "payeeName": "ABC", "amount": "20.00", "transactionTimestamp": "2022-01-28T14:44:51+05:30" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:upiUiScanPayClientAuthResp // block:start:payClientAuthReq { "requestId": "8cbc3fad-8b3f-40c0-ae93-2d7e75a8624a", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "merchantId": "stock", "customerId": "abcde12345", "clientAuthToken": "", "authExpiry" : "2023-07-19T14:15:40Z", "accountRefId" : "ABC123456789", "amount" : "2.00", "gatewayReferenceId": "ABC123", "orderId" " "ABC123456789" } } // block:end:payClientAuthReq // block:start:payClientAuthResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "payload": { "action": "upiTxn", "txnUuid": "moz3hjuAtiiQriCVFBn", "selectedAccount": { "vpa": "abc@xyz", "account": { "type": "SAVINGS", "referenceId": "A0387f9jkl54476183527acfaf9491", "otpLength": "6", "name": "XXXXat", "mpinSet": "true", "mpinLength": "6", "maskedAccountNumber": "XXXXXXX20000", "isPrimary": "true", "ifsc": "AAAA1236543", "branchName": "", "bankName": "MYPSP", "bankCode": "500001", "bankAccountUniqueId": "082eedaa58700e492179e97841584HJ8d39a4cff9275ef8ee9bc59f9186d3d68", "atmPinLength": "4" } }, "status": "SUCCESS" "orderId": "ABC1234567890" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:payClientAuthResp // block:start:onboardingAndCreateMandate-ClientAuthReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "onboardingAndPay", "shouldCreateMandate": true, "merchant_id": "stock", "customer_id": "abcde12345", "order_id": "ABC1234567890", "clientAuthToken": "", "authExpiry" : "2023-07-19T14:15:40Z", "accountRefId" : "ABC123456789", "amount": "2.00", "gatewayReferenceId": "ABC123", "metadata.:mandate_name": "metadata.YES_BIZ:ABC", "options.create_mandate": "REQUIRED", "mandate.max_amount": "2000.00", "mandate.amount_rule": "FIXED", "mandate.frequency": "MONTHLY", "mandate.start_date": "166674893389237", "mandate.end_date": "16667389373820323", "mandate.block_funds" : "true", "mandate.rule_type" : "ON/BEFORE/AFTER", "mandate.rule_value" : "Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern.", "payType" : "P2P_PAY" } } // block:end:onboardingAndCreateMandate-ClientAuthReq // block:start:onboardingAndCreateMandate-ClientAuthResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "payload": { "action": "onboardingAndPay", "status": "SUCCESS", "mandate": { "amount": "10.00", "amountRule": "EXACT", "blockFund": "false", "expiry": "2022-01-02T14:17:06+05:30", "gatewayMandateId": "YJPMe5c9711f1ede1f5524e2fadb48003aa0", "gatewayReferenceId": "806115044725", "gatewayResponseCode": "00", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseStatus": "SUCCESS", "initiatedBy": "PAYER", "mandateName": "Test Mandate", "mandateTimestamp": "2021-12-30T14:17:06+05:30", "merchantCustomerId": "DEMO-1234", "merchantRequestId": "eulb1a4418b4ac", "orgMandateId": "BJJMe5c9711f1ede1f5524e2f92648y03aa0", "payeeMcc": "4924", "payeeName": "GROWW", "payeeVpa": "growwuat@ypay", "payerName": "customer1", "payerRevocable": "true", "payerVpa": "customer1@ypay", "recurrencePattern": "WEEKLY", "recurrenceRule": "BEFORE", "recurrenceValue": "2", "refUrl": "https://www.google.com", "remarks": "Sample Remarks", "role": "PAYER", "shareToPayee": "true", "transactionType": "UPI_MANDATE", "umn": "uniqueMandateNumber@ypay", "validityEnd": "2022/09/20", "validityStart": "2022/01/20" } }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:onboardingAndCreateMandate-ClientAuthResp // block:start:createMandateClientAuthReq { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "shouldCreateMandate": true, "merchant_id": "stock", "customer_id": "abcde12345", "orderId ": "ABC123456789", "accountRefId" : "", "timestamp": "1668389349848", "amount": "200.00", "gatewayReferenceId": "ABC123", "order_id": "ABC1234567890", "clientAuthToken": "", "authExpiry" : "2023-07-19T14:15:40Z", "accountRefId" : "ABC123456789", "amount": "2.00", "metadata.:mandate_name": "metadata.YES_BIZ:ABC", "options.create_mandate": "REQUIRED", "mandate.max_amount": "2000.00", "mandate.amount_rule": "FIXED", "mandate.frequency": "MONTHLY", "mandate.start_date": "166674893389237", "mandate.end_date": "16667389373820323", "mandate.block_funds" : "true", "mandate.rule_type" : "ON/BEFORE/AFTER", "mandate.rule_value" : "Recurrence Rule for Mandate. It is not required for ONETIME, DAILY and ASPRESENTED recurrencePattern." } } // block:end:createMandateClientAuthReq // block:start:createMandateClientAuthResp { "requestId": "79fc93aa-2d98-49c9-bbb1-2beaafd4f3b6", "service": "in.juspay.hyperupi", "payload": { "action": "upiTxn", "status": "SUCCESS", "mandate": { "amount": "10.00", "amountRule": "EXACT", "blockFund": "false", "expiry": "2022-01-02T14:17:06+05:30", "gatewayMandateId": "YJPMe5c9711f1ede1f5524e2fadb48003aa0", "gatewayReferenceId": "806115044725", "gatewayResponseCode": "00", "gatewayResponseMessage": "Your transaction is successful", "gatewayResponseStatus": "SUCCESS", "initiatedBy": "PAYER", "mandateName": "Test Mandate", "mandateTimestamp": "2021-12-30T14:17:06+05:30", "merchantCustomerId": "DEMO-1234", "merchantRequestId": "eulb1a4418b4ac", "orgMandateId": "BJJMe5c9711f1ede1f5524e2f92648y03aa0", "payeeMcc": "4924", "payeeName": "GROWW", "payeeVpa": "growwuat@ypay", "payerName": "customer1", "payerRevocable": "true", "payerVpa": "customer1@ypay", "recurrencePattern": "WEEKLY", "recurrenceRule": "BEFORE", "recurrenceValue": "2", "refUrl": "https://www.google.com", "remarks": "Sample Remarks", "role": "PAYER", "shareToPayee": "true", "transactionType": "UPI_MANDATE", "umn": "uniqueMandateNumber@ypay", "validityEnd": "2022/09/20", "validityStart": "2022/01/20" } }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:createMandateClientAuthResp ``` ### InappManagement.txt ``` // block:start:managementReq { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action": "management", "merchantKeyId": "", "signature": "", "signaturePayload": "", "shouldExitOnDeregister" : "true" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:managementReq // block:start:managementResp { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperapi", "payload": { "action": "management", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:managementResp // block:start:incomingIntentReq { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperapi", "payload": { "action": "incomingIntent", "merchantKeyId": "", "signature": "", "signaturePayload": "" "intentData": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:incomingIntentReq // block:start:incomingIntentResp { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperapi", "payload": { "action": "incomingIntent", "status": "PAYMENT_SUCCESS", "accountReferenceId": "abcde12345abcde", "gatewayResponseCode": "", "gatewayResponseMessage": "Your transaction is successful", "gatewayReferenceId": "1234567890", "actionPerformed": "approve" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:incomingIntentResp // block:start:approveCollectReq { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperapi", "payload": { "action": "approveCollect", "gatewayTransactionId": "ABC123456789", "merchantKeyId": "", "signature": "", "signaturePayload": "" "intentData": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:approveCollectReq // block:start:approveCollectResp { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperapi", "payload": { "action": "approveCollect", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:approveCollectResp // block:start:incomingMandateIntentReq { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperapi", "payload": { "action": "incomingMandate", "merchantKeyId": "", "signature": "", "signaturePayload": "" "intentData": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:incomingMandateIntentReq // block:start:incomingMandateIntentResp { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperapi", "payload": { "action": "incomingMandate", "status": "PAYMENT_SUCCESS", "accountRefId": "ABC123456789", "gatewayMandateId": "", "gatewayResponseCode": "", "gatewayResponseMessage": "Your transaction is successful", "gatewayReferenceId": "1234567890", "actionPerformed": "approve" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:incomingMandateIntentResp // block:start:approveMandateReq { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperapi", "payload": { "action": "approveMandate", "merchantKeyId": "", "gatewayMandateId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:approveMandateReq // block:start:approveMandateResp { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperapi", "payload": { "action": "approveMandate", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:approveMandateResp ``` --- ## See Also - [Check Balance](https://juspay.io/in/docs/upi-plugin-sdk/ios/process-payloads/check-balance) - [P2M Transaction Status](https://juspay.io/in/docs/upi-plugin-sdk/ios/backend-apis/p2m-transaction-s)