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

      Fetch Link API

      Checksum required: Yes

      Use Case


      API can be used to get all links created as per the filters defined by the merchant. The merchant can filter by

      1. Date
      2. Link Status
      3. Link/Invoice ID
      4. Recipient Name
      5. Recipient Mobile
      6. Recipient Email

      Request 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. Current version is v1.No
      channelId stringChannel by which call is initiatedYes
      tokenType AESType of tokenYes
      signature StringChecksum string created by using Paytm checksum logicYes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      mid StringMerchant unique identifier, Unique Id for merchant provided by PaytmYes
      linkId StringUnique Link IdentifierNo
      merchantRequestId StringUnique Id sent by merchantNo
      pageNo intNo. of pages = Total no. of Links/Page SizeNo
      pageSize intPage SizeNo
      searchFilterRequestBody SearchFilterRequestBodyNo
      linkDescription Stringthis is the link-description from which link can be fetchedNo
      customerName Stringthis is customerName from which link can be fetchedNo
      customerPhone Stringthis is customerPhone Number through which link can be fetchedNo
      customerEmail Stringthis is customerEmail through which link can be fetchedNo
      paymentStatus Stringthis is the payment status values which link can be fetchedNo

      SeachFilterRequest

      ATTRIBUTEDESCRIPTIONMANDATORY
      fromDate StringDate FromNo
      toDate StringDate ToNo
      isActive BooleanWhether Link is Active or not.No

      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
      links LinkDetails of the LinksYes
      mid stringMerchant unique identifier, Unique Id for merchant provided by PaytmYes
      countLink stringCount of Links as part of the resultYes
      resultInfo stringStatus of the PaymentYes

      CustomerContact

      ATTRIBUTEDESCRIPTION
      customerName stringName of the customer
      customerEmails stringEmail id of the customer
      customerMobiles stringcustomerMobiles

      NotificationDetails

      ATTRIBUTEDESCRIPTION
      customerName stringName of the Customer which will be sent in the notification message
      Contact stringContact Number of customer where the notification will be sent
      notifyStatus stringStatus of the notification
      timestamp stringUnix Timestamp of the response

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

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

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