Fetch Transaction API

Checksum required: YES

Use Case


Fetch Transaction API would be used to fetch the transactions against a link.

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
pageNo intPage NumberNO
pageSize intPage Size = Total Links/Total no. of PagesNO
searchStartDate StringFrom DateNO
searchEndDate StringTo DateNO

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
orders jsonOrder DetailsYES
merchantId stringUnique Identifier for MerchantYES
merchantName stringMerchant NameYES
resultInfo stringResult information, refer the Result JSON Object tableYES

Orders JSON Object

PARAMETERDESCRIPTIONMandatory
txnId StringPaytm Transaction IdYES
orderId StringUnique Order IDYES
mercUniqRef StringLink ID or Invoice IDYES
orderCreatedTime StringTime of Order CreationYES
orderCompletedTime StringTime of Order completionYES
orderStatus StringStatus of the OrderYES
customerPhoneNumber StringPaytm Registered Number used by customer to make paymentYES
customerEmail StringPaytm Registered Email used by customer to make paymentNO
customerName StringPaytm Registered Name used by customer to make payment.NO
txnAmount doubleTransaction AmountYES
reconId StringUnique Order IDYES

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

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

Request CodeResponse JSON
curl -X POST https://securegw-stage.paytm.in/link/fetchTransaction -H 'Content-Type: application/json' -d '{"body":{"mid":"xxxxxxxxxxxxxxxxxxx","linkId":"81","pageNo":"1","pageSize":"20","searchStartDate":"25/03/2019","searchEndDate":"10/04/2019"},"head":{"timestamp":xxxxxxxxxx,"clientId":"XXX","version":"v1","channelId":"WEB","tokenType":"XXX","signature":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}}'