--- page_source: https://docs.juspay.io/upi-inapp/flutter/headless-process-payloads/delete-vpa page_title: Delete Vpa --- ## Delete Vpa This api deletes a customer vpa and its mapping to corresponding accounts. After deletion, same customer can claim that vpa again anytime. Here same customer means customer with the same merchantCustomerId and mobileNumber. ### 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 upiDeleteVpa for this call. - Value: upiDeleteVpa - Tags: String, Mandatory - **CustomerVpa**: - Description: Vpa to be deleted - Tags: String, Mandatory - **CustomerPrimaryVpa**: - Description: Vpa that is set as primary. - Tags: String, 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 - Value: 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 . - **UdfParameters**: - Description: Stringified json for udf parameters - 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**: - Value: upiDeleteVpa - Tags: String, Mandatory - **Status**: - Description: Whether request was successful - Value: SUCESS/FAILURE - 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 - **ResponseCode**: - Description: Response code returned - Tags: String, Mandatory - **ResponseMessage**: - Description: Response message for code returned - Tags: String, Mandatory - **VpaAccounts**: - Description: List of remaining vpa accounts. It's an array of Vpa Accounts - Value: - **Vpa**: - Description: Vpa - Tags: String, Mandatory - **Account**: - Description: Account linked to this vpa - Value: - **BankCode**: - Description: IIN Code for the bank - Tags: String, Mandatory - **BankName**: - Description: Name of bank - Tags: String, Mandatory - **MaskedAccountNumber**: - Description: Account Number with last few digits visible - Tags: String, Mandatory - **AccountNumber**: - Tags: String, Optional - **MpinLength**: - Description: Length of mpin - Tags: String, Mandatory - **MpinSet**: - Description: Is mpin set - Value: true / false - Tags: String, Mandatory - **ReferenceId**: - Tags: String, Mandatory - **Type**: - Description: Type of account - Tags: String, Optional - **BranchName**: - Description: Name of branch in which account is registered - Tags: String, Optional - **BankAccountUniqueId**: - Description: Unique Identifier for bank account across banks - Tags: String, Optional - **Ifsc**: - Description: Account IFSC - Tags: String, Optional - **IsPrimary**: - Description: Is this account the primary account - Value: true / false - Tags: String, Optional - **Name**: - Description: Name of account holder - Tags: String, Optional - **OtpLength**: - Description: Length of OTP - Tags: String, Mandatory - **AtmPinLength**: - Description: Length of atm pin - Tags: String, Mandatory - Tags: JSON, Mandatory - **IsDefault**: - Description: If this the default Vpa - Value: true / false - Tags: Boolean, Mandatory - Tags: Array of JSON, Mandatory - **OtherInfo**: - 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": { "action": "upiDeleteVpa", "customerPrimaryVpa": "8809800980@stockaxis", "customerVpa": "abc0980@stockaxis", "merchantKeyId": "1234", "signaturePayload": "", "signature": "", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1641533238616" } ``` #### Kotlin Code Snippet: ```kotlin { "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" } ``` ## Sample Code Snippets: ### Request snippets: #### Request Code Snippet: ```request { "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" } ``` ### Response snippets: #### Response: ```plaintext { "service": "in.juspay.hyperapi", "requestId": "f97f71db-5d16-42c9-b829-a12059ef6abc", "payload": { "vpaAccounts": [{ "vpa": "8809800980@stockaxis", "isDefault": true, "account": { "type": "SAVINGS", "referenceId": "Afeb13dcb1c14e7eb0a2dba7ad8b2b", "otpLength": "6", "name": "Venkat", "mpinSet": "true", "mpinLength": "6", "maskedAccountNumber": "XXXXXXX20000", "ifsc": "AABC0876543", "branchName": "Koramangala 1st Block", "bankName": "MYPSP", "bankCode": "500001", "bankAccountUniqueId": "082eedaa58700e492179e97841584ab8d39a4cff9275ef8ee9bc59f9186d3d68", "atmPinLength": "6" } }, { "vpa": "8809800980@stockaxis", "isDefault": false, "account": { "type": "SAVINGS", "referenceId": "Ae2cc1f946864fbc8d7de235478ce2", "otpLength": "6", "name": "Venkat", "mpinSet": "true", "mpinLength": "6", "maskedAccountNumber": "XXXXXXX20000", "ifsc": "AABD0000001", "branchName": "Koramangala 1st Block", "bankName": "Mybank", "bankCode": "500007", "bankAccountUniqueId": "476a0681cdb5e378d6bdc1f6fefc29423afe6f2cb5beccec5cd06a8e964f2b17", "atmPinLength": "4" } } ], "status": "SUCCESS", "responseMessage": "SUCCESS", "responseCode": "SUCCESS", "merchantId": "stock", "merchantCustomerId": "8809800980", "merchantChannelId": "stockAPP", "action": "upiDeleteVpa" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } ```