Expire Link API

Checksum required: YES

Use Case


  • This API will be used to create new payment links
  • It can be used to create all 3 types of links
  • The merchant also has an option to send the link to a customer via SMS/Email

Request Parameters

API Content format: JSON

Head

PARAMETERDESCRIPTIONMANDATORY
Timestamp longUnix Timestamp of the requestYES
clientId stringClientId by which key checksum is created, required to validate the checksumYES
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
merchantRequestId StringUnique ID to be generated by merchant.NO
Mid StringMerchant unique identifier, Unique Id for merchant provided by PaytmYES
linkId StringLink ID for which updation request is madeYes

Customer Contact JSON Object

PARAMETERDESCRIPTIONMANDATORY
customerName StringName of the customerNO
customerEmail StringEmail id of the customerNO
customerMobile StringMobile Number of the customerNO

Response Parameters

Head

PARAMETERDESCRIPTIONMANDATORY
timestamp longUnix Timestamp of the requestYES
clientId stringClientId by which key checksum is created, required to validate the checksumYES
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
resultInfo JSON Object jsonResult information, refer the Result JSON Object tableYES

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/expire

Production: https://securegw.paytm.in/link/expire

Request CodeResponse JSON
curl -X POST https://securegw-stage.paytm.in/link/expire -H 'Content-Type: application/json' -d '{"body":{"mid":"xxxxxxxxxxxxxxxxxxxx","linkId":"83"},"head":{"timestamp":"1554798113","clientId":"C11","version":"v1","channelId":"WEB","tokenType":"AES","signature":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}}'