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 Parameters

Head

PARAMETERDESCRIPTIONMANDATORY
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 v1YES
channelId stringChannel by which call is initiatedYES
tokenType AESType of tokenYES
signature StringChecksum string created by using Paytm checksum logicYes

Body

PARAMETERDESCRIPTIONMANDATORY
mid StringMerchant unique identifier, Unique Id for merchant provided by PaytmYes
linkId StringUnique Link IdentifierNo
merchantRequestId StringUnique Id sent by merchant
NO
pageNo intNo. of pages = Total no. of Links/Page SizeNO
pageSize intPage SizeNO
searchFilterRequestBody jsonNO
linkDescription Stringthis is the link-description from which link can be fetched
NO
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 JSON Object

PARAMETERDESCRIPTIONMANDATORY
fromDate StringDate FromNO
toDate StringDate ToNo
isActive BooleanWhether Link is Active or not.No

Response Parameters

Head

PARAMETERDESCRIPTIONMANDATORY
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 v1YES
channelId stringChannel by which call is initiatedYES
tokenType AESType of tokenYES
signature StringChecksum string created by using Paytm checksum logicYes

Body

PARAMETERDESCRIPTIONMANDATORY
links jsonDetails 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

Link JSON Object

PARAMETERDESCRIPTION
Link ID longUnique Link Identifier
merchantUniqueId stringUnique Identifier sent by merchant
shortUrl stringSmart Payment Link URL. This should be shared with the customer
linkName stringName as specified by the merchant at the time of Link creation
linkDescription stringDescription of Link as set by each merchant
linkType stringType of Link
amount doubleLink Amount
isActive booleanIs Link Active or not?
expiryDate stringLink Expiry Date
merchantHtml stringThis can be used to create a ‘Pay with Paytm’ button on merchant App & Website. Please embed this HTML behind the button.
createdDate StringDate & Time of Creation of the Link
status stringLink Creation Status
NotificationDetails JSONNotification Details
customerContact JSONContact Details of Customer

Customer Contact JSON Object

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

NotificationDetails JSON Object

PARAMETERDESCRIPTION
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 JSON Object

PARAMETERDESCRIPTIONMANDATORY
resultStatus StringStatus of API callYES
resultCode intResult code for each resultYES
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 -H 'Content-Type: application/json' -d '{"body":{"mid":"xxxxxxxxxxxxxxxxxxx","linkId":"83","pageNo":"1","pageSize":"20","merchantRequestId":"xxxxxxxxxxxxxxxxxxxxxxx","searchFilterRequestBody":{"fromDate":"25/03/2019","toDate":"10/04/2019","isActive":"true"}},"head":{"timestamp":1556699395,"clientId":"XXX","version":"v1","channelId":"WEB","tokenType":"XXX","signature":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}}'