• Getting Started
    • Website Integration
      Mobile Integration (Android/IOS)
      Enterprise Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Webhooks
      Testing
      Refunds
      Guides
      Other Processes

      Validate Asset API

      Checksum required: Yes

      Use Case


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

      Request Attributes

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      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 v1.No
      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

      ATTRIBUTEDESCRIPTIONMANDATORY
      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 UserNameName of the person holding the account/VPA.No
      mobileNo String(10)Account holder mobile number.No

      UserName

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

      Response Attributes

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      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)Version of the API passed in the request.No
      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

      ATTRIBUTEDESCRIPTIONMANDATORY
      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

      ATTRIBUTEDESCRIPTIONMANDATORY
      resultCode String (5)Result code for each resultYes
      resultStatus StringStatus of API call
      (S:Success, F:Failure, U:Unknown)
      Yes
      resultMsg String (256)Message contain the information about the resultYes

      Result Codes and Messages

      resultCoderesultStatusresultMsg
      01STxn Success
      330FPaytm checksum mismatch.
      335FInvalid merchant Id.
      501FCurrently, we are facing some issue, please try after some time.
      600FInvalid request parameters
      601FInvalid A/c Number or IFSC Code.
      602FInvalid VPA.
      603FRisk Verification failed for this account/vpa.

      Endpoints

      Staging: https://securegw-stage.paytm.in/userAsset/token/create?mid={mid}&requestId={unique-request-id}

      Production: https://securegw.paytm.in/userAsset/token/create?mid={mid}&requestId={unique-request-id}

      Request CodeResponse JSON
      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}"}}'