POSTValidate VPA API

Use Case

To validate user VPA address in case UPI collect flow.

Query Params

ATTRIBUTE	DESCRIPTION
mid string mandatory	Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation. Example: INTEGR7769XXXXXX9383
orderId string conditional	This is the unique identifier for order and should have the same value as used in orderId of Initiate Transaction API or Initiate Subscription API. Note: It becomes mandatory in case tokenType value is sent as CHECKSUM or TXN_TOKEN in this request. Example: OREDRID_98765
referenceId string conditional	This is the unique reference id and should have the same value as used in Access Token API. Note: It becomes mandatory in case tokenType value is sent as ACCESS in the request.

ATTRIBUTE

DESCRIPTION

mid

string
mandatory

Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.
Example: INTEGR7769XXXXXX9383

orderId

string
conditional

This is the unique identifier for order and should have the same value as used in orderId of Initiate Transaction API or Initiate Subscription API.
Note: It becomes mandatory in case tokenType value is sent as CHECKSUM or TXN_TOKEN in this request.
Example: OREDRID_98765

referenceId

string
conditional

This is the unique reference id and should have the same value as used in Access Token API.
Note: It becomes mandatory in case tokenType value is sent as ACCESS in the request.

Request Attributes

Content Type : JSON

Head

Attribute	Description
version string optional	Version of the API. Example: v1
channelId string optional	The parameter value identifies the Channel for which API call is initiated. Possible values: WEB For websites, the value to be passed should be "WEB" , WAP For Mobile websites/App, the value to be passed should be "WAP"
requestTimestamp string optional	EPOCH timestamp of the time at which request is being sent. Example: 1588402269
tokenType string mandatory	Authorization method for this request. Possible values: ACCESS To be used in case authentication is done using access token. , TXN_TOKEN To be used in case authentication done using transaction token.
token string mandatory	Authorization string corresponding to the tokenType used. Example: 739816707d7444XXXXXXXX6cb4264d0a1590145379323

Body

Attribute	Description
vpa string conditional	User VPA address Example: 7777777777@paytm
numericId string conditional	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. Example: 9595959595
mid string conditional	Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation. Note: Mandatory, if the tokenType is ACCESS Example: INTEGR7769XXXXXX9383

Response Attributes

Content Type : JSON

Head

Attribute	Description
version string	Version of the API passed in the request. Example: v1
responseTimestamp string	EPOCH timestamp of the time at which response is being sent. Example: 1588402269

Body

Attribute

Description

resultInfo

object

This parameter gives the information about the result of the API response

ResultInfo

Attribute	Description
resultCode string	This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below.
resultStatus string	This parameter indicates the status of API call. Possible values: S For Success , F For Failure
resultMsg string	This parameter is the result message which contains information about the result. The different result messages corresponding to this API are mentioned below in section " Response Codes and Messages".

vpa

string

User VPA address

Example: 7777777777@paytm

valid

boolean

Status of VPA

recurringDetails

object

This parameter gives the information about the support for UPI autopay for subscriptions.

RecurringDetails

Attribute	Description
pspSupportedRecurring string	This parament indicates if the PSP app supports the UPI autopay for subscriptions. Possible values: True, False
bankSupportedRecurring string	This parameter indicates if the primary bank associated with the VPA supports UPI autopay for subscriptions. In the case of @paytm handle, this parameter is true if any of the bank accounts linked to the VPA supports UPI autopay. Possible values: True, False

extraParamsMap

object

Map for any extra information (in case of error).

Response Codes & Messages

resultCode	resultStatus	resultMsg
0000	S	Success
0	F	System Error, invalid param
0001	F	Error in Verification, Try Again Merchant VPA incorrect Invalid UPI Number, Try Again Invalid VPA, Try Again VPA restricted. Try again. UPI Number restricted. Try again. UPI Number does not exist Verified VPA Verified UPI Number
00000900	F	System error
501	F	Sorry! We could not verify the VPA
1001	F	Request prameters are not valid
1006	F	Your Session has expired.
2004	F	SSO Token is invalid
2013	F	Mid in the query param doesn't match with the Mid send in the request
2014	F	OrderId in the query param doesn't match with the OrderId send in the request

⇾

Staging

Production

https://securegw-stage.paytm.in/theia/api/v1/vpa/validate?mid={mid-here}&orderId={order-id-here} copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/vpa/validate?mid=3NTEGR91883569975797&orderId=RHL_1608548086_20201221162446' \
--header 'Content-Type: application/json' \
--data '{"body":{"vpa":"7777777777@paytm","mid":"3NTEGR91883569975797"},"head":{"version":"v1","requestTimestamp":1608548094,"requestId":1608548094,"tokenType":"TXN_TOKEN","txnToken":"9bcfb95364e24040bcd79affdd2cf5951608548093035"}}'