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

      Update Link API

      Checksum required: Yes

      Use Case


      • This API would be used to update the existing links for the merchant
      • Please note that only Link Description and Expiry Date can be modified.

      Request Attributes

      API Content format: JSON

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      timestamp longUnix Timestamp of the requestYes
      clientId StringClientId by which key checksum is created, required to validate the checksumNo
      versionStringVersion of the API. Current version is v1No
      channelId StringChannel by which call is initiatedYes
      tokenType AESType of tokenYes
      Signature StringChecksum string created by using Paytm checksum logicYes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      merchantRequestId StringUnique ID to be generated by merchant.No
      mid StringMerchant unique identifier, Unique Id for merchant provided by PaytmYes
      linkId longLink ID for which updation request is madeYes
      linkDescription StringDescription of the link that merchant wants to display to customerYes
      expiryDate StringExpiry date of the link that needs to be updatedYes
      amount DoubleAmount that needs to be updatedNo

      Response Attributes

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      timestamp longUnix Timestamp of the requestYes
      clientId StringClientId by which key checksum is created, required to validate the checksumNo
      version StringVersion of the API passed in the request.No
      channelId StringChannel by which call is initiatedYes
      tokenType AESType of tokenYes
      signature StringChecksum string created by using Paytm checksum logicYes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      resultInfo ResultInfoResult information, refer the Result JSON Object tableYes

      ResultInfo

      ATTRIBUTEDESCRIPTIONMANDATORY
      resultCode StringResult code for each resultYes
      resultStatus StringStatus of API call
      (S:Success, F:Failure, U:Unknown)
      Yes
      resultMessage StringMessage contain the information about the resultYes

      Endpoints

      Staging: https://securegw-stage.paytm.in/link/update

      Production: https://securegw.paytm.in/link/update

      Request CodeResponse JSON
      curl -X POST 'https://securegw-stage.paytm.in/link/update' --header 'Content-Type: application/json' --data '{"body":{"mid":"{mid}","linkId":"{link-id}","linkDescription":"{link-description}"},"head":{"tokenType":"AES","signature":"{signature}"}}'