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

      post Validate Asset API

      Use Case


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

      Request Attributes


      API Content Type: JSON

      Head1

      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: WEBFor websites, the value to be passed should be "WEB", WAPFor Mobile websites/App, the value to be passed should be "WAP"
      signature string(108)
      mandatory
      Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library
      Body1

      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
      Benificiary account number,Mandatory if user want to validate account number.
      ifscCode string(11)
      optional
      bank Ifsc code,Mandatory if user want to validate account number.
      name UserName
      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


      API Content Type: JSON

      Head2

      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.
      Example: v1
      channelId string(3)
      The parameter value identifies the Channel for which API call is initiated.
      Possible Values: WEBFor websites, the value to be passed should be "WEB", WAPFor Mobile websites/App, the value to be passed should be "WAP"
      signature string(108)
      Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library
      Body2

      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: SFor Success, FFor Failure
      resultMsg string(256)
      This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below
      token string(128)
      in case of success, token is returned, used in refund API

      Response 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.
      StagingProduction
      REQUESTRESPONSE
      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}"}}'