Body
Add Vpa
This api creates an alias to an existing vpa. All the accounts liked to customerPrimaryVpa will be linked to customerVpa.
If deleteCustomerPrimaryVpa is passed as "true" then customerPrimaryVpa will be deleted. This api can also be used for Edit Vpa functionality.
Note
Regex for vpa prefix is
^[a-zA-Z0-9]([a-zA-Z0-9-\.]{1,23})[a-zA-Z0-9]$.Regex for mobile number vpa prefix is
^[0-9]{10,12}$.If a customer has already created vpa of his mobile number, he cannot create another mobile number vpa.
This is an idempotent api.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/vpas/addDefault
Headers
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.
Parameters
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints : Alphanumeric string with dot(.). Maximum length is 256.
customerVpa
*
String
Mandatory
New vpa that is to be added
customerPrimaryVpa
*
String
Mandatory
Existing vpa whose alias is to be created
deleteCustomerPrimaryVpa
*
Boolean String
Mandatory
Flag denoting whether to delete customerPrimaryVpa
udfParameters
Json String
optional
Stringified JSON for udf parameters
200 : Success
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
vpaAccounts
*
Array of json
Mandatory
Details of the active linked vpa account mappings
Values : VpaAccount array
udfParameters
JSON string
optional
Udf parameters as passed in the request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt