POSTUpdate Link API

Use Case

This API would be used to update the existing links for the merchant
Please note that only the following parameters can be modified
- Link Expiry
- Link notes
- Maximum number of payments allowed
- Template attached to the link

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
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 mandatory	Link ID for which updation request is made
expiryDate string(15) optional	Expiry date of the link that needs to be updated
changeTemplate boolean optional	To change for Template related with templateId
templateId int optional	Attach a form specified by the template ID to your link
linkNotes string optional	Add additional notes to your link. This won’t be shown to your customers
maxPaymentsAllowed string optional	Specify the maximum number of payments you wish to accept via the link

Response Attributes

Content Type : JSON

Head

Attribute	Description
timestamp string(15)	EPOCH timestamp of the time at which request 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.

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.
5021	FAILED	Expiry date is invalid.
5022	FAILED	Merchant not allowed payment forms
5028	FAILED	Checksum provided is invalid.
5029	FAILED	request body cannot be empty
5030	FAILED	request head cannot be empty

⇾

Staging

Production

https://securegw-stage.paytm.in/link/update copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securegw-stage.paytm.in/link/update' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","linkId":"31309","linkDescription":"Testing Payment"},"head":{"tokenType":"AES","signature":"{signature}"}}'