POSTResend Notification Link API

Use Case

This API would be used to send notifications to customers for link on Email & SMS.

Request Attributes

Content Type : JSON

Head

Attribute	Description
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 string 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

Attribute

Description

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

string

mandatory

This is the unique link id for which notification needs to be sent

sendSms

boolean

optional

If True the SMS would be sent on the number shared

sendEmail

boolean

optional

If True Email would be sent on the email shared

notifyContact

object

optional

NotifyContact

CustomerContact

Attribute	Description
customerName string optional	Name of the customer
customerEmail string optional	Email id of the customer
customerMobile string optional	Mobile Number of the customer.

Response Attributes

Content Type : JSON

Head

Attribute	Description
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(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: 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 string	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

Attribute

Description

resultInfo

object

This parameter gives the information about the result of the API response

ResultInfo

Attribute	Description
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.

notificationDetails

array

Details require to send link via SMS and Email to the customer. Customer Name is mandatory

NotificationDetails

Attribute	Description
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

Response Codes & Messages

resultCode	resultStatus	resultMessage
200	SUCCESS	Success
404	FAILED	Data Not Found
501	FAILED	Internal Server Error
502	FAILED	Unknown Error Occurred
5004	FAILED	empty merchant Id.
5028	FAILED	Checksum provided is invalid.
5029	FAILED	request body cannot be empty
5030	FAILED	request head cannot be empty
5055	FAILED	Sending payment notification is not permitted on a paid link.
5056	FAILED	Sending payment notification is not permitted in an expired link.
5057	FAILED	Cannot send payment notification as Partial payment is in progress, please wait or try again later.

⇾

Staging

Production

https://securestage.paytmpayments.com/link/resendNotification copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securestage.paytmpayments.com/link/resendNotification' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","linkId":"31309","sendSms":true,"notifyContact":{"customerMobile":"7777777777"}},"head":{"tokenType":"AES","signature":"{signature}"}}'