search

POSTValidate VPA API

Use Case

This API returns if the VPA address passed in the request is valid and whether it supports subscription payments.

Request Attributes

Content Type : JSON

Head

AttributeDescription
version
string
optional

Version of the API.

channelId
Enum
mandatory

Channel through which call is initiated.
For websites, the value is WEB
For Mobile websites/App, the value is WAP.

requestTimestamp
string
optional

UNIX timestamp of the time request is being sent

tokenType
string
mandatory

Authorization method for this request.
 

Possible values: 
ACCESS , TXN_TOKEN

token
string
mandatory

Authorization string corresponding to the tokenType used.

Body

AttributeDescription
mid
string
mandatory

merchant id

vpa
string
mandatory

User VPA address

numericId
string
mandatory

Unique ID between 8-11 digits mapped to VPA. 10 digit is reserved for mobile number. 8 and 9 digit for custom numbers.
Note: Either VPA or numericID must be used.

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string

EPOCH timestamp of the time at which response is being sent.

version
string

Version of the API.

Body

AttributeDescription
resultInfo
object

This parameter gives the information about the result of API response 

resultInfo
+
AttributeDescription
resultStatus
string

This parameter is the result specific to the phase of the transaction mentioned in the txnType field

resultCode
string

This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64.

resultMsg
string

This parameter is the result message which contains information about the result.

vpa
string

User VPA address

 

Example: 7777777777@paytm

valid
boolean

Status of the VPA

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
1007FMissing Mandatory Element
0FSystem Error, invalid param
00000900FSystem error
1006FSession Expired Exception
2004FInvalid User Token
501FParam Missing
00000004FParameter ILLEGAL
613FJWT is invalid
Staging
Production
https://stage-router.paytm.in/theia/api/v1/vpa/validate?mid={mid}&orderId={orderID}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location 'https://stage-router.paytm.in/theia/api/v1/vpa/validate?mid=YOUR_MID_HERE&orderId=dev1227' \
--header 'Content-Type: application/json' \
--data-raw '{"head": {"version": "v1","requestTimestamp": 1608548094,"requestId": 1608548094,"tokenType":"TXN_TOKEN","token":"8d8c557b-3208-4351-91c8-fa6a6af5e849"},"body": {"vpa": "7777777777@paytm","mid": "YOUR_MID_HERE"}}'

 

copy icon