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

      Expire Link API

      Checksum required: Yes

      Use Case


      • This API will be used to create new payment links
      • It can be used to create all 3 types of links
      • The merchant also has an option to send the link to a customer via SMS/Email

      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
      version StringVersion 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 StringLink ID for which updation request is madeYes

      CustomerContact

      ATTRIBUTEDESCRIPTIONMANDATORY
      customerName StringName of the customerNo
      customerEmail StringEmail id of the customerNo
      customerMobile StringMobile Number of the customerNo

      Response Attribute

      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/expire

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

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