This page lists every parameter used by the Paytm App Invoke SDK. Request parameters are passed as arguments of the PaytmPayments / NcmcPayments methods. Response parameters are the keys of the responseData map delivered to IPaytmResult.onResult. All amounts are in paise (1200 = ₹12.00).
|
Name |
Request |
SDK method(s) |
Description |
|
activity |
Request(Mandatory) |
All methods |
Live foreground Activity of the calling application. The SDK launches a singleTask loading Activity from it and closes it automatically when the response arrives. |
|
paytmResult |
Request(Mandatory) |
All methods |
IPaytmResult callback (PaytmPayments.IPaytmResult or NcmcPayments.IPaytmResult). onResult receives the responseData map, onError receives an errorMsg. |
|
orderId |
Request(Mandatory)/Response(Mandatory) |
All methods |
Alphanumeric and unique for every new payment or NCMC request. Returned as is in the response. For checkStatus and doVoid pass the orderId of the original payment. |
|
requestId |
Request(Optional) |
All methods |
Integer used to correlate the response with the request. Auto-generated (epoch seconds) when not provided. Every method also returns it. |
|
amountInPaise |
Request(Mandatory) |
doPayment, doPreAuth, doMoneyAdd |
Amount in paise. Minimum 100 (₹1.00). Amount 1200 means ₹12.00, last two digits are for paise. |
|
amount |
Response(Mandatory) |
doPayment, checkStatus, doVoid, doPreAuth, NcmcPayments methods |
Transaction amount in paise as processed by the EDC app. |
|
payMode |
Request(Optional, default "ALL") |
doPayment |
Restricts the payment channel. Values: "CARD", "QR", "ALL". |
|
subWalletInfo |
Request(Optional) |
doPayment |
Map of Paytm sub-wallet to amount in paise for QR payments, e.g. {"FOOD":"2000", "GIFT":"3000"}. Supported wallets: FOOD and GIFT. The sum of the amounts must be less than or equal to amountInPaise. |
|
printInfo |
Request(Optional) |
doPayment |
Map of key-value pairs that need to be printed on the SALE receipt. These are not recorded with the transaction. |
|
extendInfo |
Request(Optional) |
doPayment, doPartialRefund, sendSMS, doMoneyAdd, doUpdateBalance, doCreateService |
Map of key-value pairs recorded along with the transaction. These values are not printed on the receipt. Values may be plain strings or JSON strings. |
|
optionalParams |
Request(Optional) |
All PaytmPayments methods |
Map of additional key-value pairs sent with the request and returned as is in the response. This is also how the optional keys below are passed: completeOrderTimeout, productValidationValue, tipAmount, totalAmount, keyType, keysCsv, dataSep. A key that matches a predefined parameter is ignored. |
|
gstInfo |
Request(Optional) |
doPayment |
GstInfo(gstIn, gstInvoiceNo, gstInvoiceDate, gstBrkUp). All four fields must be non-null if GST information needs to be passed while creating the QR code. |
|
completeOrderTimeout |
Request(Optional) |
doPayment |
Timeout in seconds for automatically completing the order on the Payment Status page. Must be between 0 and 30, otherwise it is ignored. Default 30 seconds. |
|
productValidationValue |
Request(Optional) |
doPayment |
Serial Number or IMEI of the selected Brand EMI product. |
|
tipAmount |
Request(Optional) |
doPayment |
Tip amount in paise. Must not be more than the maximum allowed amount for the merchant. |
|
totalAmount |
Request(Conditional) |
doPayment |
Mandatory when tipAmount is present. Must equal amountInPaise + tipAmount, otherwise the request is rejected by the Payments app. |
|
flowType |
Request(Mandatory) |
NcmcPayments methods |
Flow identifier. Use "transit" for NCMC operations; if not sent the EDC app returns Invalid Command. The closed-loop methods of PaytmPayments set flowType internally. |
|
isOsa |
Request(Optional, default false)/Response |
doReadCard, doCreateService |
Configures whether the operation targets the Common Service Area or the Operator Service Area. Honoured only with flowType "transit". |
|
serviceType |
Request(Mandatory) |
doMoneyAdd |
Source of funds for Add Money. |
|
cardNoSHA |
Request(Optional) |
doMoneyAdd, doUpdateBalance |
Hashed card number as returned in tag 5A by doReadCard / doCheckBalance. When provided, the EDC app verifies that the tapped card is the same card. |
|
readMethod |
Request(Optional) |
doReadCard |
Card read method hint. Values: "tap", "insert", "swipe", "default". |
|
requestTags |
Request(Optional) |
doReadCard, doCheckBalance |
List of EMV tags required by the third party app, e.g. listOf("5A", "DF33"). The values of all requested tags are returned in the same sequence in responseTags. |
|
responseTags |
Response |
doReadCard, doCheckBalance |
Comma-separated values in the same order as requestTags. Each value is UTF-8 encoded. |
|
manufactureType |
Request(Mandatory) |
readCloseLoopCard, updateCloseLoopCard, updateCardKey, piccCmdExchangeCloseLoopCard |
Closed-loop card manufacturing type. MF - Mifare Classic, MFU - Mifare Ultralight, MFUC - Mifare Ultralight C. |
|
cardBlockNumber |
Request(Mandatory for update / key update, Optional for read) |
readCloseLoopCard, updateCloseLoopCard, updateCardKey |
Block number(s) to read or write, e.g. "1" or comma-separated "1,2,4". For updateCardKey it is the sector number. |
|
cardData |
Request(Mandatory) |
updateCloseLoopCard, updateCardKey |
Hex block value(s) to write, comma-separated in the same order as cardBlockNumber, e.g. "12345678" or "12345678,87655432". Maximum 16 bytes per block. |
|
cmdData |
Request(Mandatory) |
piccCmdExchangeCloseLoopCard |
Raw APDU command (hex) sent to the closed-loop card. |
|
isEof |
Request(Mandatory) |
piccCmdExchangeCloseLoopCard |
End-of-flow flag. "true" = final command, the card session closes after the response. "false" = more commands follow, the card session stays open. |
|
isAsyncRequest |
Request(Optional, default false) |
readCloseLoopCard, updateCloseLoopCard, updateCardKey, piccCmdExchangeCloseLoopCard |
If true the card operation is performed in the background through the EDC service instead of the loading Activity. Only async requests can be cancelled with cancelRequest. |
|
keyType |
Request(Optional) |
readCloseLoopCard, updateCloseLoopCard |
Card authentication key type: TYPE_A (default) or TYPE_B. Other values are ignored. |
|
keysCsv |
Request(Optional) |
readCloseLoopCard, updateCloseLoopCard |
Card authentication key(s), default FFFFFFFFFFFF. Comma-separated, one per requested block, e.g. FFFFFFFFFFFF,FFFFFFFFFFFF. When fewer keys than blocks are given, the default key is used for the remaining blocks. |
|
dataSep |
Request(Optional) |
readCloseLoopCard, updateCloseLoopCard |
Separator for multi-block cardBlockNumber / cardData values when a comma is not suitable, e.g. "|" with cardBlockNumber "1|2|3|4" and cardData "10809|28898|379789|47876". Default ",". |
|
cancelResult |
Request(Mandatory) |
cancelRequest |
IPaytmCancelResult callback. onCancelResult(requestId, cancelled, errorCode, errorMsg) is called exactly once on the main thread. |
|
status |
Response(Mandatory) |
All methods |
Final status of the request. |
|
errorCode |
Response |
All methods |
Error code returned either by the Paytm server or by the EDC app when a request is not successful. |
|
errorMsg |
Response |
All methods |
Error message returned either by the Paytm server or by the EDC app when a request is not successful. |
|
stan |
Response(Mandatory) |
All methods |
Unique transaction counter. |
|
RRN |
Response |
doPayment, doMoneyAdd, doUpdateBalance |
Retrieval Reference Number returned by the bank for card transactions. |
|
txnId |
Response |
doPayment, doMoneyAdd, doUpdateBalance, doCreateService |
Paytm Transaction Id. |
|
cardNo |
Response |
doPayment, NcmcPayments methods, readCloseLoopCard, updateCloseLoopCard, updateCardKey, piccCmdExchangeCloseLoopCard |
Masked card number for card payments and NCMC operations. For closed-loop cards the actual serial number / UUID is returned. |
|
cardBalance |
Response |
doMoneyAdd, doUpdateBalance, doCheckBalance |
Card balance in paise: the updated balance after Add Money / Update Balance, or the current balance for Check Balance. |
|
cardBlockValue |
Response |
readCloseLoopCard, updateCloseLoopCard |
Closed-loop card block values in the same order as cardBlockNumber. |
|
fBlock |
Response |
updateCloseLoopCard |
When some blocks are written successfully and a few fail, the failed block numbers are returned comma-separated, e.g. "1,2". |
|
fBlockErrCode |
Response |
readCloseLoopCard, updateCloseLoopCard |
Error codes of the blocks that failed to read / write, in the requested order, comma-separated, e.g. "-16,-20". |
|
response |
Response |
piccCmdExchangeCloseLoopCard |
Raw response returned by the card for cmdData. |
|
eof |
Response |
piccCmdExchangeCloseLoopCard |
"true" when the card session is closed, "false" when it stays open for the next command. Always "true" on failure. |
|
cardType |
Response |
doPayment |
Card type CREDIT or DEBIT in case of payment through card. |
|
responsePayMode |
Response |
doPayment, doMoneyAdd, doUpdateBalance |
Pay mode used: EMI, CARD or QR. |
|
payMethod |
Response |
doPayment |
Method of payment (CREDIT_CARD, DEBIT_CARD, UPI, WALLET etc.). |
|
txnDate |
Response |
doPayment, NcmcPayments methods |
Transaction date and time. |
|
authCode |
Response |
doPayment, doMoneyAdd |
Authorisation code returned by the bank, null in case of QR payment. |
|
tid |
Response |
doPayment, NcmcPayments methods |
Terminal ID of the EDC device. |
|
aid |
Response |
doPayment, NcmcPayments methods |
AID used for the card transaction. |
|
cardScheme |
Response |
doPayment, NcmcPayments methods |
Card scheme name (VISA, MASTER, Rupay Prepaid ...). |
|
issuingBank |
Response |
doPayment, NcmcPayments methods |
Card issuing bank name. |
|
acquiringBank |
Response |
doPayment |
Name of the acquiring bank for the SALE transaction. |
|
bankResponseCode |
Response |
doPayment, doMoneyAdd |
Bank response code returned by the bank. |
|
bankMid |
Response |
doPayment, doMoneyAdd, doUpdateBalance |
Bank MID. |
|
bankTid |
Response |
doPayment, doMoneyAdd, doUpdateBalance |
Bank TID. |
|
productManufacturer |
Response |
doPayment |
Brand name of the product in case of Brand EMI SALE. |
|
productCategory |
Response |
doPayment |
Category of the product in case of Brand EMI SALE. |
|
productSerialNoType |
Response |
doPayment |
Validation key of the product in case of Brand EMI SALE. |
|
productSerialNoValue |
Response |
doPayment |
Validation value of the product in case of Brand EMI SALE. |
|
emiTxnType |
Response |
doPayment |
Type of EMI (Brand or Bank). |
|
emiTenure |
Response |
doPayment |
Tenure of EMI. |
|
emiInterestRate |
Response |
doPayment |
Interest rate of EMI. |
|
emiMonthlyAmount |
Response |
doPayment |
Monthly amount of EMI. |
|
emiTotalAmount |
Response |
doPayment |
Total amount of EMI (with interest). |
|
bankOfferApplied |
Response |
doPayment, NcmcPayments methods |
true if an EMI cashback / bank offer is applied, otherwise false. |
|
bankOfferType |
Response |
doPayment |
Bank offer type of EMI. |
|
bankOfferAmount |
Response |
doPayment |
Bank offer amount of EMI. |
|
subventionCreated |
Response |
doPayment, NcmcPayments methods |
true if EMI subvention cashback is created, otherwise false. |
|
subventionType |
Response |
doPayment |
Subvention type in Brand EMI SALE. |
|
subventionOfferAmount |
Response |
doPayment |
EMI cashback amount in Brand EMI. |
*Keys passed in optionalParams are returned as is in the response. If the name of an optionalParams key matches a predefined parameter, that key is ignored.