POSTSale API

Request Time (yyyy-MM-dd HH:mm:ss) is the time when a request is sent to the Paytm system.

Example: 2019-10-07 13:15:18

Paytm will provide the channel Id to the merchant.

Example: ABC

Check sum of whole body. For creating the checksum (signature) refer to the steps given in Checksum Logic.

 Note: Create the checksum using the body parameter of the request.

Example: FFFFFFFFFF2345000004

client version

Example: 1.0

Paytm generated merchant Id

Example: FINALE32321107827478

Paytm generated terminal Id

Example: 12345678

Transaction Time(yyyy-MM-dd HH:mm: ss) Time when the transaction is initiated at the client system.

Example: 2019-10-07 13:15:18

Merchant's system generated Transaction Id(TxnId). It should be unique for each transaction. 
It should be alphanumeric (special characters not allowed)

Example: 2091293484338398383

Merchant's system generated Reference number associated with order ID. This number will be displayed on the payment acceptance pop-up on the device and will be sent back in the status inquiry response. 

Example: 2091293484338398383

transaction amount in paise.

Example: 1000

Transaction-specific parameters can be sent in this field. 

• If auto accept true is passed, transaction acceptance pop up will not be shown on device. 
• Payment mode can be used to pre select transaction pay mode. 
• BrandID, ModelID, EMI tenures, featureType IMEI, phone number, invoice are all EMI related parameters which can be passed pre facto here so that manual entry of EMI params is skipped on device. 
   

Example:

"autoAccept" : "True", "paymentMode": "ALL/CARD/QR", "brandID" : "579507", "modelID" : "TV784", "featureType" : "1,2,3", "emiTenures" : "3,6,9", "imei" : "123456", "phoneNumber" : "9999999999", "invoiceNumber" : "12345", "splitMethod" : "PERCENTAGE", "splitData", [ "vendorID" , "123456" "value" , "50" ]

Merchant can send split settlement logic (percentage split / amount split) and values in this field for each transaction.

Example: "splitMethod": "PERCENTAGE", "splitData": [ "vendorID" : "123456", "value": "50" ]

Merchant can send extra fields as per the use case. The same will be sent back in the transaction status inquiry response. 

Example: "extendInfo": {"key1": "value1","key2": "value2"}

Cap amount for different user sub wallets (amount in paise) 
The possible values for the User SubWalletType Enum are:
FOOD, GIFT, MULTI_PURPOSE_GIFT, TOLL, CLOSED_LOOP_WALLET, CLOSED_LOOP_SUB_WALLET, FUEL, INTERNATIONAL_FUNDS_TRANSFER, CASHBACK, GIFT_VOUCHER, COMMUNICATION

Example: FOOD:100|GIFT : 100"

These fields will be displayed on the payment acceptance pop-up on the device.

Example: "displayInfo": {"key1": "value1","key2": "value2", "key3": "value3"}

These fields will get printed on EDC receipts  under 'Merchant's payment details' section. 

Example: "printInfo": {"key1": "value1", "key2": "value2"}

gstInformation field is optional, but fields within gstInformation are not optional, they are all mandatory if you decide to add gstInformation in your request. In case any of the fields are missing, GST parameters will be ignored.

Example: "gstInformation" : {"gstIn": "08TESTF0078P1ZP", "gstBrkUp": "CGST:10|SGST:10| IGST:10| CESS:10|GSTIncentive:10| GSTPCT:10", "invoiceNo": "Invoice3423432155555", "invoiceDate": "20210511132200"}

Only to be used if retry payment functionality is enabled for the merchant. The value will be incremented on each retry payment attempt (+1).

Example: 1

Possible values: AT_TXN, POST_FACTO

It can be an integer between 1 and 60.

Example: 2