requestType string mandatory | This parameter is used to identify the transaction flow.
Possible Values: 'Payment' for 'One time Payment' for all checkout flows
|
mid string 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
|
orderId string mandatory | The Unique reference ID of the Order. It is alphanumeric and max length is 50 characters.
Example: OREDRID_98765
|
callbackUrl string conditional | Paytm sends the response of transaction on the URL which comes in the callbackUrl parameter. If this param is not present then websiteName param key will be used to get the static callbackUrl.
Example: https://<callback URL to be used by merchant>
Note: Either of websiteName or callbackUrl should be passed in the request.
|
websiteName string mandatory |
websiteName is the key to extract the static callbackUrl defined for merchant at Paytm. This is provided by Paytm.
Possible Values:
WEBSTAGING
For Staging/Integration environment
,
DEFAULT
For Production environment
Note: URL passed in callbackUrl has a higher preference over the URL configured against this key.
|
txnAmount object optional | This parameter is an object and should contain the value of transaction i.e. amount and currency type.
Example: {"value" : "1.00", "currency" : "INR"}
|
Attribute | Description |
---|
value string mandatory | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string mandatory | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
|
userInfo object mandatory | User information contains user details like customer ID, email, phone number etc.
|
Attribute | Description |
---|
custId string mandatory | Unique reference ID for every customer which is generated by merchant. Special characters allowed in CustId are @, ! ,=,_ ,$, .
Example: CUST_001
| mobile string conditional | 10-digit mobile number of user.
Example: 9988000000
Mandatory, in case merchant wants to give Debit Card EMI as a payment option to its users.
| email string optional | Valid email of the user.
Example: vaibhav41094@gmail.com
| firstName string optional | | lastName string optional | |
|
paytmSsoToken string optional | This is a unique token linked with user's Paytm wallet and is provided in the response while linking user's Paytm wallet.
|
enablePaymentMode array of objects optional |
List of the payment modes which needs to enable. If the value provided then only listed payment modes are available for transaction.
Example: [{"mode" : "UPI", "channels" : ["UPIPUSH"]}]
|
Attribute | Description |
---|
mode string optional | Mode of Payment
BALANCE,
For Paytm Wallet
PPBL, UPI,
For Paytm Payments Bank
CREDIT_CARD
For Credit Card
DEBIT_CARD
For Debit Card
NET_BANKING
For Net Banking
PAYTM_DIGITAL_CREDIT
For paytm postpaid
| channels Array of strings optional | Channel associated with mode.
Possible Values:
For UPI:
UPIPUSHEXPRESS
For UPI Push
For CREDIT_CARD/DEBIT_CARD/EMI: VISA, MASTER, AMEX
For NET_BANKING: SBI, PNB, HDFC, ICICI. List of Banks
| banks Array of strings optional | Different Banks are available
"ICICI", "SBI", "AXIS". List of banks
|
|
disablePaymentMode array of objects optional | List of the payment modes which need to disable. If the value provided then all the listed payment modes are unavailable for transaction.
Example: [{"mode" : "UPI", "channels" : ["UPIPUSH"]}]
|
Attribute | Description |
---|
mode string optional | Mode of Payment
BALANCE,
For Paytm Wallet
PPBL, UPI,
For Paytm Payments Bank
CREDIT_CARD
For Credit Card
DEBIT_CARD
For Debit Card
NET_BANKING
For Net Banking
PAYTM_DIGITAL_CREDIT
For paytm postpaid
| channels Array of strings optional | Channel associated with mode.
Possible Values:
For UPI:
UPIPUSHEXPRESS
For UPI Push
For CREDIT_CARD/DEBIT_CARD/EMI: VISA, MASTER, AMEX
For NET_BANKING: SBI, PNB, HDFC, ICICI. List of Banks
| banks Array of strings optional | Different Banks are available
"ICICI", "SBI", "AXIS". List of banks
|
|
promoCode string optional | It is the code that has been applied during the transaction on the merchant website.
Example: TESXXXOMO
|
goods array of objects optional | This contain the goods info for an order
|
Attribute | Description |
---|
merchantGoodsId string optional | Unique id for the goods item (item no)
| merchantShippingId string optional | | snapshotUrl string optional | | description string mandatory | | category string optional | | quantity string mandatory | | unit string optional | Unit of quantity (KG/Litre)
| price object mandatory | | Attribute | Description |
---|
value string mandatory | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string mandatory | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
| extendInfo object optional | | Attribute | Description |
---|
udf1 string optional | User define parameter 1. Merchant will receive this parameter in the callback and transaction status API response.
| udf2 string optional | User define parameter 2. Merchant will receive this parameter in the callback and transaction status API response.
| udf3 string optional | User define parameter 3. Merchant will receive this parameter in the callback and transaction status API response.
| mercUnqRef string optional | | comments string optional | | subwalletAmount string 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 Balance (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.
|
|
|
shippingInfo object optional | This contain the shipping info for an order.
|
Attribute | Description |
---|
merchantShippingId string optional | | trackingNo string optional | | carrier string optional | | chargeAmount object optional | | Attribute | Description |
---|
value string mandatory | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string mandatory | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
| countryName string optional | | stateName string optional | | cityName string optional | | address1 string optional | | address2 string optional | | firstName string optional | | lastName string optional | | mobileNo string optional | | zipCode string optional | | email string optional | Valid email of the user.
Example: vaibhav41094@gmail.com
|
|
extendInfo object optional | Merchant can pass any order specific information that is required to be passed here.
|
Attribute | Description |
---|
udf1 string optional | User define parameter 1. Merchant will receive this parameter in the callback and transaction status API response.
| udf2 string optional | User define parameter 2. Merchant will receive this parameter in the callback and transaction status API response.
| udf3 string optional | User define parameter 3. Merchant will receive this parameter in the callback and transaction status API response.
| mercUnqRef string optional | | comments string optional | | subwalletAmount string 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 Balance (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.
|
|
VanInfo object optional | |
Attribute | Description |
---|
merchantPrefix string(4) mandatory | Merchant identifier issued to the merchant at the time of onboarding. Merchants can opt for names resembling their business names.
Example: Paytm can opt for merchant prefix as PYTM.
| identificationNo string(10) conditional | This is 10 digits alphanumeric string that forms that last 10 digits of the VAN. While merchants can use this in multiple ways possible, this should be unique to the entity against which reconciliation is required. The length of this is fixed and hence needs to be accommodated for while passing this string.
| purpose string(256) optional | The purpose for which VAN is getting created. This is free string that can be passed by merchant. The value passed in these fields will be available in order APIs, webhooks, VAN APIs, transaction and settlement report against the payment received for a particular VAN.
|
|
payableAmount object optional | |
Attribute | Description |
---|
value string mandatory | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string mandatory | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
|
splitSettlementInfo object optional | Note: Send only in case split settlement required
|
Attribute | Description |
---|
splitType string optional | Possible values: AT_TXN / POST_TXN or blank, blank is also considered as AT_TXN with below split infos.
| postTxnSplitTimeout string optional | Timeout in no. of calender days. Either leave it blank or pass 1 for same day timeout.
| splitMethod string mandatory | Split method
Possible Values: AMOUNT, PERCENTAGE
| splitInfo Array mandatory | List for child vendor merchant mid's and their split info
| Attribute | Description |
---|
mid string mandatory | | amount object conditional | Share of child vendor in the split by amount base
Use: Only splitMethod is AMOUNT
| Attribute | Description |
---|
value string mandatory | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string mandatory | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
| percentage string conditional | Share of child vendor in the split by percentage base
Use: Only splitMethod is PERCENTAGE
| partnerId string conditional | Optional alternate id created for child MID
| goods object optional | Split merchant goods info list
| Attribute | Description |
---|
merchantGoodsId string optional | Unique id for the goods item (item no)
| merchantShippingId string optional | | snapshotUrl string optional | | description string mandatory | | category string optional | | quantity string mandatory | | unit string optional | Unit of quantity (KG/Litre)
| price object mandatory | | Attribute | Description |
---|
value string mandatory | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string mandatory | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
| extendInfo object optional | | Attribute | Description |
---|
udf1 string optional | User define parameter 1. Merchant will receive this parameter in the callback and transaction status API response.
| udf2 string optional | User define parameter 2. Merchant will receive this parameter in the callback and transaction status API response.
| udf3 string optional | User define parameter 3. Merchant will receive this parameter in the callback and transaction status API response.
| mercUnqRef string optional | | comments string optional | | subwalletAmount string 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 Balance (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.
|
|
| shippingInfo object optional | Split merchant shipping info list
| Attribute | Description |
---|
merchantShippingId string optional | | trackingNo string optional | | carrier string optional | | chargeAmount object optional | | Attribute | Description |
---|
value string mandatory | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string mandatory | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
| countryName string optional | | stateName string optional | | cityName string optional | | address1 string optional | | address2 string optional | | firstName string optional | | lastName string optional | | mobileNo string optional | | zipCode string optional | | email string optional | Valid email of the user.
Example: vaibhav41094@gmail.com
|
| extendInfo string optional | | Attribute | Description |
---|
udf1 string optional | User define parameter 1. Merchant will receive this parameter in the callback and transaction status API response.
| udf2 string optional | User define parameter 2. Merchant will receive this parameter in the callback and transaction status API response.
| udf3 string optional | User define parameter 3. Merchant will receive this parameter in the callback and transaction status API response.
| mercUnqRef string optional | | comments string optional | | subwalletAmount string 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 Balance (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.
|
|
|
|
unifiedOffersToken string conditional | Get unifiedOffersToken from Apply Offer API
Example:a18fa0d896444b18a237d5XXXXdbc79e1576762049265
|
simplifiedUnifiedOffers object conditional | Object of Simplified Unified Offer to apply offers on a transaction.
Either simplifiedUnifiedOffers object or unifiedOffersToken will have to be passed in case of offer integration.
|
Attribute | Description |
---|
promoDetails object conditional | Object to be passed for applying bank offer
| Attribute | Description |
---|
applyAvailablePromo boolean optional | Default Promo to be applied.
Possible Values: true, false
Default: true
| validatePromo boolean optional | To validate Promo to be applied and fail transaction accordingly.
Possible Values: true, false
Default: false
| isAmountBasedBankOffer boolean optional | To run amount based bank offer, send this as true. Else send this as false.
Possible Values: true, false
Default: true
| offerId string conditional | It is the identifier for the offer that has been applied during the transaction on the merchant website.
Example: 2134516
| promoAmount Double optional | The amount eligible for applying offer/promo. Can be used incase the offer has to be applied on partial transaction amount
|
| subventionDetails object conditional | Object to be passed for applying EMI Subvention
| Attribute | Description |
---|
pgPlanId string optional | EMI plan id needs to be sent only in those cases where you either keep the plan ids data at your end or receive the same in any API response.
Example: ICICI|3
Note: This param need not be send for EMI subvention integration through All-in-one SDK or JS checkout
| isAmountBasedSubvention boolean optional | To run amount based subvention send this as true. Else send this as false.
Possible Values: true, false
Default: true
| subventionAmount double conditional | Amount on which subvention is to be applied for amount based validation (mandatory for amount based subvention).
| offerId string conditional | OfferId that is enabled on the product (mandatory for amount based subvention).
|
| items object optional | | Attribute | Description |
---|
id string mandatory | Any unique identifier for one item in the request e.g. in case of 2 items in the cart, the values can be sent as 1234 and 1236.
| productId string mandatory | Unique product identifier for the merchant.
| brandId string mandatory | Product brand identifier for the merchant
Example: LG, Sony etc. Should be send in the request if EMI plans are configured with brand attribute.
| categoryId string mandatory | Product category identifier for the merchant (categories can be Electronics, footwears etc). This should be sent in the request with same value which is configured in the EMI plan.
| price Integer mandatory | |
|
|