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

is Vpa Available

This api checks for the availability of the VPA and also provides suggestion, if the passed vpa is not available.

This is an idempotent api.
Checking availability for a existing vpa of customer will return available as true.
Customer can claim alias@handle vpas or mobileNumber@handle vpa where the mobileNumber will be the one from which the customer is linked on UPI ecosystem.
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}$.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{uri}/merchants/vpas/availability

                      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

VPA of the customer for which the availability check is called.

Constraints : something@handle

                      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

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API

                      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

                      available
                      *
                      

String

Mandatory

Availablity Status

Values : String - “true”, “false”

                      vpaSuggestions
                      
                      

Array of Strings

optional

VPA suggestions for the customer generated using a random combination of customers’ name, mobile number, and account details. This will come only when available is false.

Values : [qwer@abcd,…]

                      udfParameters
                      
                      

Json String

optional

Udf parameters as passed in the request

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