Body
Check UPI Number Availability
This endpoint will be used to check if a UPI Number is available and also to check the current status of a UPI number. In case of mobile UPI number it will also let us know if we can port the UPI number with the action as PORT.
Request
Response
API Endpoints
Production Link
POST
http://{{host}}/api/{uri}/merchants/upiNumber/availability
Headers
Content-Type
*
string
Required
application/json
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
*
integer
Required
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
x-merchant-signature
*
string
Required
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
Parameters
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer
Constraints : Alphanumeric string with dot(.). Maximum length is 256.
upiRequestId
*
String
Mandatory
Unique id sent to UPI switch
Constraints : 35 character alphanumeric that starts with a unique merchant prefix
upiNumber
*
String
Mandatory
Number mapped to a customer’s VPA that is unique to the customer across the UPI ecosystem
Constraints : 8 to 10 digit numeric string. 10 digit number must be the mobile number. Last 3 digits must not be same. Must not start with a 0.
vpa
*
String
Mandatory
Vpa to be linked with the provided Upi Number
Constraints : vpa@handle
action
*
String
Mandatory
Action to be performed on UPI Number
Constraints : CHECK or PORT
deviceFingerPrint
*
String
Mandatory
Device fingerprint of the customer
fallbackDeviceFingerPrint
String
optional
Fallback Device fingerprint of the customer
udfParameters
Json String
optional
Stringified JSON for udf parameters
200 : Success
Response Body
status
*
String
Mandatory
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
merchantCustomerId
*
String
Mandatory
Merchant generated unique profile id for customer as passed in the request
merchantChannelId
*
String
Mandatory
Unique id for the merchant channel as passed in request headers
merchantId
*
String
Mandatory
Unique id for the merchant as passed in request headers
customerMobileNumber
*
String
Mandatory
Mobile number of the customer.
Values : 12 character string
gatewayTimestamp
*
String
Mandatory
Gateway timestamp for the Api call.
Values : String(YYYY-MM-DDTHH:MM:SS+05:30)
gatewayTransactionId
*
String
Mandatory
Transaction id returned by gateway. Same as upiRequestId passed in request
gatewayResponseStatus
*
String
Mandatory
Response status returned by gateway.
Values : String(SUCCESS, FAILURE)
gatewayResponseCode
*
String
Mandatory
Response code returned by gateway. Refer the table below for all possible values.
gatewayResponseMessage
*
String
Mandatory
Response message for code returned by gateway.
status
*
String
Mandatory
Status of the Upi Number.
Values : String(ACTIVE, DISABLED, DELETED, NEW)
upiNumber
*
String
Mandatory
Number mapped to a customer’s VPA that is unique to the customer across the UPI ecosystem
Values : As passed in request
existingVpa
*
String
Mandatory
Vpa linked with the upiNumber (Only in case of PORT)
Values : vpa@handle
udfParameters
JSON String
Optional
Stringified json for udf parameters.