search
Your Paytm for business app is working and will keep working beyond March 15th, 2024. Click to know more

POSTValidate Asset API

Use Case

To initiate partial or complete refund directly in your bank account which will be reflected instantly.

Request Attributes

Content Type : JSON

Head

AttributeDescription
requestTimestamp
string(15)
optional

EPOCH timestamp of the time at which request is being sent.
Example: 1588402269

clientId
string(3)
optional

Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.

Example: C11

version
string(4)
optional

Version of the API.

Example: v1

channelId
string(3)
mandatory

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"
signature
string(108)
mandatory

Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic.
Note: Create the signature using the body parameter of the request.

Body

AttributeDescription
mid
string(20)
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

requestId
string(32)
mandatory

Unique reference ID for a transaction which is generated by merchant and sent in the request

vpa
string(20)
optional

user VPA address, Mandatory if user want to validate VPA.

Example: 7777777777@paytm

accountNumber
string(18)
optional

Beneficiary account number. Mandatory, if a user wants to validate the account number.

ifscCode
string(11)
optional

Bank Ifsc code. Mandatory, if a user wants to validate the account number.

name
object
optional

Name of the person holding the account/VPA.

userName
+
AttributeDescription
firstName
string(64)
optional

user first name

lastName
string(64)
optional

user last name

mobileNo
string(10)
optional

Account holder mobile number.

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string(15)

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

clientId
string(3)

Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.

Example: C11

version
string(4)

Version of the API passed in the request.
Example: v1

channelId
string(3)

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"
signature
string(108)

Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic.
Note: Create the signature using the body parameter of the request.

Body

AttributeDescription
resultInfo
object

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

ResultInfo
+
AttributeDescription
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".

token
string(128)

In case of success, the token is returned, used in refund API.

Response Codes & Messages

resultCoderesultStatusresultMsg
01 S Txn Success
330 F Paytm checksum mismatch.
335 F Invalid merchant Id.
501 F Currently, we are facing some issue, please try after some time.
600FInvalid request parameters
601 F Invalid A/c Number or IFSC Code.
602 F Invalid VPA.
603 F Risk Verification failed for this account/vpa.
Staging
Production
https://securegw-stage.paytm.in/userAsset/token/create?mid={mid}&requestId={unique-request-id}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
curl -X POST 'https://securegw-stage.paytm.in/userAsset/token/create?mid={mid}&requestId={unique-request-id}' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","requestId":"{unique-request-id}","name":{"firstName":"{customer-first-name}","lastName":"{customer-last-name}"},"mobileNo":"{customer-mobile-number}","accountNumber":"{customer-bank-account-number}","ifscCode":"{customer-bank-ifsc-code}"},"head":{"signature":"{signature}"}}'
copy icon