search

POSTFetch Link API

Use Case

This 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

Content Type : JSON

Head

AttributeDescription
timestamp
string(15)
optional

EPOCH timestamp of the time at which request is being sent.
Example: 1588402269

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:
WEB
For websites, the value to be passed should be "WEB"
,
WAP
For 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 request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic.
Note: Create the signature using the body parameter of the request.

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

Page Number

pageSize
int
optional

Page Size = Total Links/Total no. of Pages

searchFilterRequestBody
object
optional

Seach Filter Request 

SeachFilterRequest
+
AttributeDescription
fromDate
string
optional

Date From

toDate
string
optional

Date To

isActive
boolean
optional

Whether Link is Active or not.

linkTypeMultiple
array
optional

Link type

Possible Values: ["FIXED","GENERIC"]

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

Possible Values: PENDING, INIT, EXPIRED, PAID

invoiceId
string
optional

invoice number or unique id

Response Attributes

Content Type : JSON

Head

AttributeDescription
timestamp
string(15)

EPOCH timestamp of the time at which response is being sent.
Example: 1588402269

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

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:
WEB
For websites, the value to be passed should be "WEB"
,
WAP
For 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 request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic.
Note: Create the signature using the body parameter of the request.

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
object

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

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

shortUrl
string

Smart Payment Link URL. This should be shared with the customer

longUrl
string

Payment Link URL. Not to be shared with the customer

successfulPaymentCount
string

Total count of successful payment

isPartialPaymentEnabled
boolean

Partial payment is enabled or not

isPaymentFormAttached
boolean

Payment form is attached or not

linkNotes
string

Link notes

fields
object

Fields

Fields
+
AttributeDescription
name
string

Field name

type
string

Type of field
(Text, Date, Numeric, Dropdown)
For Amount: Amount, QuantityAmount

displayText
string

Field display text

helpText
string

Help text for field

constraints
object

Constraints for a field which will be apply in input

Constraints
+
AttributeDescription
maxLength
string

Character maximum length in this field - Text & Numeric Only

minLength
string

Character minimum length in this field - Text & Numeric Only

maxValue
string

Maximum value of this field - Date & Numeric Only

minValue
string

Minimum value of this field - Date & Numeric Only

allowedValues
string

Multiple values of this field - Dropdown Only
 

Example: ["Male","Female"]

beforeTransaction
boolean

Conditional field (it will use before transaction or not) - Date Only

value
string

Amount value
For Fixed and Quantity Amount

minQuantity
string

Minimum Quantity - For Quantity Amount

maxQuantity
string

Maximum Quantity - For Quantity Amount

orientation
string(H, V)

To be displayed vertical or horizontal with respect to previous field
H: Horizontal
V: Vertical

size
string

Size percentage in which field box will be displayed

isEditable
boolean

Field which can be edited by merchant

display
boolean

Field which will be displayed in suggested Fields

mandatory
boolean

Field which will be mandatory while payment

Response Codes & Messages

resultCoderesultStatusresultMessage
200SUCCESSSuccess
404FAILEDData Not Found
501FAILEDInternal Server Error
502FAILEDUnknown Error Occurred
5004FAILEDempty merchant Id.
5028FAILEDChecksum provided is invalid.
5029FAILEDrequest body cannot be empty
5030FAILEDrequest head cannot be empty
Staging
Production
https://securegw-stage.paytm.in/link/fetchcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://securegw-stage.paytm.in/link/fetch' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}"},"head":{"tokenType":"AES","signature":"{signature}"}}'
copy icon