• 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

      post Fetch Link API

      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


      API Content Type: JSON

      Head1

      Head

      ATTRIBUTEDESCRIPTION
      timestamp string(15)
      optional
      EPOCH timestamp of the time at which request is being sent.
      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: v2
      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"
      tokenType AES
      mandatory
      This parameter identifies whether the API works on checksum authentication. The value to be sent in tokenType is 'AES' for this API.
      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
      merchantRequestId string
      optional
      Unique ID to be generated by merchant.
      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
      linkId long
      optional
      Unique Identifier for each Link
      pageNo int
      optional
      No. of pages = Total no. of Links/Page Size
      pageSize int
      optional
      Page Size
      searchFilterRequestBody searchFilterRequestBody
      optional
      SeachFilterRequest +
      AttributeDescription
      fromDate string
      optional
      Date From
      toDate string
      optional
      Date To
      isActive boolean
      optional
      Whether Link is Active or not.
      linkDescription string
      optional
      this is the link-description from which link can be fetched
      customerName string
      optional
      this is customerName from which link can be fetched
      customerPhone string
      optional
      this is customerPhone Number through which link can be fetched
      customerEmail string
      optional
      this is customerEmail through which link can be fetched
      paymentStatus string
      optional
      this is the payment status values which link can be fetched

      Response Attributes


      API Content Type: JSON

      Head2

      Head

      ATTRIBUTEDESCRIPTION
      timestamp string(15)
      EPOCH timestamp of the time at which response is being sent.
      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(2)
      Version of the API passed in the request.
      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"
      tokenType AES
      This parameter identifies whether the API works on checksum authentication. The value to be sent in tokenType is 'AES' for this API.
      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: SUCCESS, FAILED
      resultMessage 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
      links links
      Details of the Links
      Links +
      AttributeDescription
      LinkID long
      Unique Link Identifier
      merchantUniqueId string
      Unique Identifier sent by merchant
      shortUrl string
      Smart Payment Link URL. This should be shared with the customer
      linkName string
      Name as specified by the merchant at the time of Link creation
      linkDescription string
      Description of Link as set by each merchant
      linkType string
      Type of Link
      amount double
      Link Amount
      isActive boolean
      Is Link Active or not?
      expiryDate string
      Link Expiry Date
      merchantHtml string
      This can be used to create a ‘Pay with Paytm’ button on merchant App & Website. Please embed this HTML behind the button.
      createdDate string
      Date & Time of Creation of the Link
      status string
      Link Creation Status
      NotificationDetails object
      Notification Details
      NotificationDetails +
      AttributeDescription
      customerName string
      Name of the Customer which will be sent in the notification message
      contact string
      Contact Number of customer where the notification will be sent
      notifyStatus string
      Status of the notification
      timestamp string
      Unix Timestamp of the response
      customerContact object
      Contact Details of Customer
      CustomerContact +
      AttributeDescription
      customerName string
      Name of the customer
      customerEmail string
      Email id of the customer
      customerMobile string
      Mobile Number of the customer.
      mid string(20)
      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
      countLink string
      Count of Links as part of the result

      Response Codes and Messages


      resultCoderesultStatusresultMessage
      200SUCCESSSuccess
      302FAILEDRequest Validation Failure
      401FAILEDInvalid Request
      404FAILEDData Not Found
      502FAILEDUnknown Error Occurred
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/link/fetch' \
      --header 'Content-Type: application/json' \
      --data '{"body":{"mid":"{mid}"},"head":{"tokenType":"AES","signature":"{signature}"}}'