JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Delete Vpa

This api deletes a customer vpa and its mapping to corresponding accounts.

After deletion, the vpa will be non-reclaimable, customer can claim his mobileNumber@handle vpa again anytime. A vpa can be reclaimed by a customer only when both mcid and mobile number is same.

Any other customer can claim same vpa only if it is inactive for a period of 2 years.

This is an idempotent api.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{{uri}}/merchants/vpaAccounts

                      Content-Type
                      *
                      

string

Required

application/json

                      x-merchant-signature
                      *
                      

string

Required

This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.

                      x-merchant-id
                      *
                      

string

Required

Will be shared while onboarding.

                      x-merchant-channel-id
                      *
                      

string

Required

Will be shared while onboarding.

                      Accept
                      *
                      

string

Required

application/json

                      x-timestamp
                      *
                      

string

Required

This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.

Body

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer

Constraints : Alphanumeric string with dot(.). Maximum length is 256.

                      customerVpa
                      *
                      

String

Mandatory

Customer vpa to be deleted

                      action
                      *
                      

String

Mandatory

Action to be performed
Value : DELETE_VPA

                      udfParameters
                      
                      

json String

Optional

Stringified JSON for udf parameters

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API

Values : SUCCESS, FAILURE

                      responseCode
                      *
                      

String

Mandatory

PSP response code for the API

Values : Refer error code section

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API

Values : Refer error code section

                      Payload
                      *
                      

JSON

Mandatory

                      merchantId
                      *
                      

String

Mandatory

Unique id for the merchant as passed in request headers

                      merchantChannelId
                      *
                      

String

Mandatory

Unique id for the merchant channel as passed in request headers

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer as passed in the request

                      customerMobileNumber
                      *
                      

String

Mandatory

Customer mobile number

Values : 12 digits mobile number string

                      vpas
                      *
                      

Array of Json

Mandatory

List of vpas added

vpa

String

                      primaryBankAccountUniqueId
                      
                      

String

                      accounts
                      *
                      

Array of json

Mandatory

List of linked accounts

                      maskedAccountNumber
                      
                      

String

                      otpLength
                      
                      

String

                      mpinSet
                      
                      

String

                      atmPinLength
                      
                      

String

                      name
                      
                      

String

                      ifsc
                      
                      

String

                      type
                      
                      

String

                      bankCode
                      
                      

String

                      mpinLength
                      
                      

String

                      bankAccountUniqueId
                      
                      

String

                      bankName
                      
                      

String

                      defaultBankAccountUniqueId
                      *
                      

String

Mandatory

Unique id for the default bank account of the customer

                      udfParameters
                      
                      

JSON String

optional

Udf parameters as passed in the request

Have questions?
Need help? Contact support
LLM? Read llms.txt