Validate Asset API

Checksum required: YES

Use Case


To initiate partial or complete refund to source account from which the transaction was done

Request Attributes:

Head

PARAMETERDESCRIPTIONMANDATORY
requestTimestamp String(15)EPOCH timestamp of the time request is being sentNo
clientId String(3)This is used in case the merchant has two different merchant keys. In case one merchant key merchant should pass - C11No
version String(4)The version of the API. The current version is v1No
channelId (enum)"For websites, the value is WEB
For Mobile websites/App, the value is WAP"
Yes
signature String(108)Checksum string created by using Paytm checksum logicYes

Body

PARAMETERDESCRIPTIONMANDATORY
mid String(20)This is a unique identifier provided to every merchant by PaytmYes
requestId String(32)Unique reference ID for a transaction which is generated by merchant and sent in the requestYes
vpa String(20)user VPA address, Mandatory if user want to validate vpa.No
accountNumber String(18)Benificiary account number,Mandatory if user want to validate account number.No
ifscCode String(11)bank Ifsc code,Mandatory if user want to validate account number.No
name UserName JSON ObjectName of the person holding the account/VPA.No
mobileNo String(10)Account holder mobile number.No

UserName

PARAMETERDESCRIPTION
firstName String(64)user first name
lastName String(64)user last name

Response Attributes:

Head

PARAMETERDESCRIPTIONMANDATORY
requestTimestamp String(15)EPOCH timestamp of the time request is being sentNo
clientId String(3)This is used in case the merchant has two different merchant keys. In case one merchant key merchant should pass - C11No
version String(4)The version of the API. The current version is v1No
channelId (enum)"For websites, the value is WEB
For Mobile websites/App, the value is WAP"
Yes
signature String(108)Checksum string created by using Paytm checksum logicYes

Body

PARAMETERDESCRIPTIONMANDATORY
token Sting(128)in case of success, token is returned, used in refund APINo
resultInfo ResultInfoInformation related to the response of the request.Yes

ResultInfo

PARAMETERDESCRIPTIONMANDATORY
resultStatus String (10)Status of API call (Success/Failure)Yes
resultCode String (5)Result code for each resultYes
resultMsg String (256)Message contain the information about the resultYes

API Result Codes

Result CodeMessageSTATUS
01Txn SuccessS
330Paytm checksum mismatch.F
335Invalid merchant Id.F
501Currently, we are facing some issue, please try after some time.F
600Invalid request parametersF
601Invalid A/c Number or IFSC Code.F
602Invalid VPA.F
603Risk Verification failed for this account/vpa.F

Endpoints

Staging: https://securegw-stage.paytm.in/userAsset/token/create?mid=YOUR_MID_HERE&requestId=UNIQUE_REQUEST_ID

Production: https://securegw.paytm.in/userAsset/token/create?mid=YOUR_MID_HERE&requestId=UNIQUE_REQUEST_ID

Request CodeResponse JSON
curl -X POST 'https://securegw-stage.paytm.in/userAsset/token/create?mid=YOUR_MID_HERE&requestId=UNIQUE_REQUEST_ID' --header 'Content-Type: application/json' --data '{"body":{"mid":"YOUR_MID_HERE","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":{"clientId":"MERCHANT_CLIENT_ID","signature":"GENERATED_CHECKSUM_VALUE"}}'