MID
String(20)
Mandatory
|
This is a unique identifier provided to every merchant by Paytm. MID is part of your account credentials and is different on staging and production environment. Your staging MID is available here and production MID will be available once your activation is complete. |
ORDER_ID
String(50)
Mandatory
|
Unique reference ID for a transaction which is generated by merchant special characters allowed in Order ID are: @, -, _,. |
CUST_ID
String(64)
Mandatory
|
Unique reference ID for every customer which is generated by merchant special characters allowed in Cust_ID are @, ! ,_ ,$,. |
TXN_AMOUNT
String(10)
Mandatory
|
Amount in INR payable by the customer. Should contain digits up to two decimal points. The only special character allowed is (“.”) |
CHANNEL_ID
String(3)
Mandatory
|
This parameter is used to control the theme of the payment page. Based on the channel passed, Paytm will render the layout suitable for that specific platform.
• For websites, the value is WEB
• For Mobile websites/App, the value is WAP
|
WEBSITE
String(30)
Mandatory
|
• For staging environment: WEBSTAGING
• For production environment: Will be available here once your activation is complete
|
PROMO_CAMP_ID
String(120)
Optional
|
This parameter is required to pass when a merchant is running any promotional campaign and it is configured at Paytm payment gateway. Merchant will get in contact with Paytm to launch any promo code campaign. |
CHECKSUMHASH
String(108)
Mandatory
|
Signature to avoid tampering. Generated using server-side checksum utility available here. |
MOBILE_NO
String(15)
Optional
|
Customer's mobile number. Passing this enables faster login for a customer into his/her Paytm account. When the customer clicks on login, the mobile number comes pre-filled on our payment page. |
EMAIL
String(50)
Optional
|
Customer's Email ID |
INDUSTRY_TYPE_ID
String(20)
Mandatory
|
• For staging environment: "Retail"
• For production environment: Will be available here once your activation is complete
|
CALLBACK_URL
String(255)
Optional
|
On completion of the transaction, Paytm payment gateway will send the response on this URL. Sample URL is - https://merchant.com/callback/ |
MERC_UNQ_REF
String(50)
Optional
|
This parameter accepts merchant defined value. In transaction request, the merchant can send his choice of value and Paytm payment gateway shall return the same value in the transaction response. Merchant can also use this identifier to search transactions on a panel. |
PAYMENT_MODE_ONLY
String(3)
Optional
|
If a merchant wants to allow payment mode selection on his website or restrict the payment to a particular paymode, then the value to be passed is “YES”.
For example, with this parameter merchant can ensure that customer only sees credit card as a paymode when he lands on Paytm's cashier page. |
AUTH_MODE
String(10)
Conditional
|
Required If PAYMENT_MODE_ONLY = YES, then
• For Credit/Debit card - 3D
• For Wallet, Net Banking, Postpaid – USRPWD
|
PAYMENT_TYPE_ID
String(15)
Conditional
|
Required If PAYMENT_MODE_ONLY = Yes, then
• Credit card payment mode – CC
• Debit card payment mode - DC
• Net banking payment mode - NB
• Paytm wallet – PPI
• EMI - EMI
• UPI - UPI
• Paytm Postpaid - PAYTM_DIGITAL_CREDIT
|
subwalletAmount
object
Optional
|
This parameter is required to limit the maximum amount that could be deducted from a particular subwallet. This parameter is only used for payMode PPI (Paytm Wallet).
Possible Keys: FOOD, GIFT, MULTI_PURPOSE_GIFT, TOLL, CLOSED_LOOP_WALLET, CLOSED_LOOP_SUB_WALLET, FUEL, INTERNATIONAL_FUNDS_TRANSFER, CASHBACK, GIFT_VOUCHER. e.g. "subwalletAmount":{ "FOOD": "2"}
NOTE: As per compliance rules, you need to send the Food item amount separately to Paytm.
|
BANK_CODE
String(5)
Conditional
|
Required If PAYMENT_MODE_ONLY = Yes PAYMENT_TYPE_ID = NB
List of Bank Codes is provided here. |