resultInfo object | This parameter gives the information about the result of the API response
|
Attribute | Description |
---|
resultCode string | This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below.
| resultStatus string | This parameter indicates the status of API call. Possible Values:
| resultMsg string | This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below.
| isRedirect boolean | This flag indicates that number of retries are over and user is to be redirected from cashier page.
| bankRetry boolean | This flag indicates that retry is allowed at bank's end or not.
| retry boolean | This flag indicates that retry is allowed at bank's end or not.
|
|
merchantDetails object | |
Attribute | Description |
---|
mcc string | mcc of the merchant
Example: 1234
| merchantVpa string | Virtual payment address of the merchant
Example: 7777777777@paytm
| merchantName string | Name of the merchant
Example: Test MID One
| merchantLogo string | Merchant profile image URL
|
|
addMoneyMerchantDetails object | Details of the merchant to add money
|
Attribute | Description |
---|
mcc string | mcc of the merchant
Example: 1234
| merchantVpa string | Virtual payment address of the merchant
Example: 7777777777@paytm
| merchantName string | Name of the merchant
Example: Test MID One
| merchantLogo string | Merchant profile image URL
|
|
orderId string | The Unique reference ID of the Order. It is alphanumeric and special characters allowed are “@” “-” “_” “.”.
Example: OREDRID_98765
|
walletOnly boolean | This flag indicates the availability of wallet payment mode only
|
zeroCostEmi boolean | This flag indicates the availability of zero cost EMI
|
pcfEnabled boolean | This flag indicates the availability of PCF
|
nativeJsonRequestSupported boolean | This flag indicates the JSON API request supported for the custom checkout
|
activeMerchant boolean | This flag indicates whether the merchant is active or blocked
|
oneClickMaxAmount boolean | Maximum amount allowed for one-click payment
Example: 2000
|
prepaidCardMaxAmount string | Maximum payment amount allowed for a pre-paid card
|
userDetails object | |
Attribute | Description |
---|
email string | | paytmCCEnabled boolean | This field indicates that PaytmCC is available
| kyc string | Has kyc of user been done or not
| username string | User name
Example: Integration Testing
| mobile string | User mobile number
Example: 7777777777
|
|
loginInfo object | |
Attribute | Description |
---|
userLoggedIn boolean | This flag indicates that user login status
| pgAutoLoginEnabled boolean | This flag indicates that auto-login available
| mobileNumberNonEditable string | |
|
iconBaseUrl string | Base URL of icons. The app will need to append the same before every iconUrl.
|
accessToken string | This is a unique transaction token received in response to Access Token API request.
Example: 739816707d7444XXXXXXXX6cb4264d0a1590145379323
|
onTheFlyKYCRequired boolean | A boolean flag which indicates whether min-kyc is required before the txn
|
paymentFlow string | Payment flow applied on merchant
Possible values:
,
ADDANDPAY
For Add and Pay
|
merchantPayOption object | Consists of the payment modes that are available on the merchant. Additionally, it consists of a list of saved cards saved against a customer.
|
Attribute | Description |
---|
paymentModes array of object | Array of different payment Modes
| Attribute | Description |
---|
paymentMode string | Possible values:
,
,
CREDIT_CARD
For Credit Card
,
DEBIT_CARD
For Paytm Wallet
,
NET_BANKING
For Net Banking
,
| displayName string | Payment mode name.
Possible Values: Paytm Balance, Paytm Payments Bank, Bhim Upi, Credit Card, Debit Card, Net Banking, Emi
| isDisabled object | This flag indicates the status of this payment mode (this object comes when this mode is disable)
| Attribute | Description |
---|
status string | | msg string | |
| payChannelOptions array of object | Payment mode channel array
| Attribute | Description |
---|
isDisabled object | This flag indicates the status of this payment channel (this object comes when this channel is disable)
| Attribute | Description |
---|
status string | | msg string | |
| hasLowSuccess object | This flag indicates the status of success rate (this object comes when success rate is low)
| Attribute | Description |
---|
status string | Success rate of this channel
| msg string | |
| iconUrl string | Payment channel icon
Example: icici.png
| minAmount object | Minimum amount for EMI plan
| Attribute | Description |
---|
value string | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
| maxAmount object | Maximum amount for EMI plan
| Attribute | Description |
---|
value string | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
| emiType string | Type of EMI
Example: DEBIT_CARD, CREDIT_CARD
| balanceInfo object | Basic details of Paytm wallet
Example: {"subWalletDetails": null,"payerAccountExists": true,"accountBalance": {"currency": "INR","value": "154.32"}}
| Attribute | Description |
---|
subWalletDetails array of object | Basic details of Paytm sub wallet
| Attribute | Description |
---|
displayName string | | balance string | | imageUrl string | |
| payerAccountExists boolean | | accountBalance object | Total balance of Paytm wallet
| Attribute | Description |
---|
value string | This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00
| currency string | This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR
|
|
| isHybridDisabled boolean | Indicates whether hybird payment is allowed or not for this payChannel
| channelCode string | PayChannel's short code
Example: ANDB
| channelName string | PayChannel's name
Example: Andhra Bank
|
| feeAmount string | | taxAmount string | Any tax amount present in PCF
| totalTransactionAmount string | Total amount in case merchant is a PCF merchant and PCF is applicable
| priority string | Signifies order of display
Example: 1
| prepaidCardSupported boolean | Indicates if prepaid card is configured on the merchant
| isHybridDisabled boolean | Whether hybrid payment mode is enabled or not for this paymethod
| onboarding boolean | This was used for postpaid onboarding. - currently being sent as false
|
| savedInstruments array of object | Array of saved card and other user saved instruments
| Attribute | Description |
---|
iconUrl string | Save instruments icon
Example: https://staticgw-stage1.paytm.in/25.1.0/
| supportedCardSubTypes array | Provides an identifier for various types of cards. Depending on your agreement, you can be charged differently for a different card.
Example:
CORPORATE_CARD which Indicates if the card used is a corporate card. Typically a merchant is charged differently for a prepaid card compared to a debit card.
| oneClickSupported boolean | Status of One-Click payment on this save instruments
| cardDetails object | Saved instruments details
| Attribute | Description |
---|
cardId string | Saved instruments id
Example: 201707291077050XXXXXX47678ef1041b96e6bcac3489
| cardType string | Possible values:
CREDIT_CARD
For Credit Card
,
DEBIT_CARD
For Debit Card
,
| expiryDate string | Saved instruments expiry date
Example: 022030
| firstSixDigit string | Saved card first six digits
Example: 411111
| lastFourDigit string | Saved card last four digits
Example: 1111
| status string | | cvvLength string | Saved card cvv length
Example: 3
| cvvRequired boolean | CVV status for this saved card
Example: 1
|
| issuingBank string | Issuing bank name
Example: JPMC
| isEmiAvailable boolean | Whether emi is available or not
| authModes array | Contains list of authentication modes available on that card
Possible Values: otp, pin
Example: ["otp"]
| displayName string | Saved instrument name
Example: JPMorgan Chase Bank Credit Card
| priority string | Indicates the priority to be given by front-end in displaying this card
Example: 3
| paymentOfferDetails object | | Attribute | Description |
---|
promocodeApplied string | Bank offer code
Example: BANKOFFERSPTTEST11
| promotext string | Message for this bank offer
Example: Promocode applied successfully
| instantDiscount string | Instant discount for this Bank offer
Example: 1.00
| cashbackAmount string | Cashback discount for this Bank offer
Example: 1.00
| payMethod string | Payment mode
Possible Values: DEBIT_CARD, CREDIT_CARD, NET_BANKING
| promoVisibility boolean | | responseCode string | Response code for this offer
|
| isHybridDisabled boolean | This instruments support the hybrid transaction or no
| channelCode string | Saved instrument channel short code
Example: VISA
| channelName string | Saved instrument channel name
Example: VISA Inc.
| prepaidCard boolean | Indicates if the saved card is also a Prepaid card or not
| isDisabled object | This flag indicates the status of this saved instrument (this object comes when this channel is disable)
| Attribute | Description |
---|
status string | | msg string | |
| hasLowSuccess object | This flag indicates the status of success rate (this object comes when success rate is low)
| Attribute | Description |
---|
status string | Success rate of this channel
| msg string | |
|
| activeSubscriptions array of object | List of Active Subscriptions
| Attribute | Description |
---|
accountNumber string | | accountHolderName string | | bankIFSC string | | bankName string | | savedCardId string | | subscriptionId string | | paymentMode string | |
| upiProfile object | Details of User's bank linked with VPA and health of npci
| Attribute | Description |
---|
respDetails object | User related data such as bankAccounts, profileStatus, deviceBinding etc.
| Attribute | Description |
---|
profileDetail object | User related data such as bankAccounts, profileStatus, deviceBinding etc.
| Attribute | Description |
---|
vpaDetails array of object | vpa details and its corresponding accRefId
| Attribute | Description |
---|
name string | Vpa of the user
Example: 7777777777@paytm
| defaultCreditAccRefId string | Default Credit accRefid of the vpa
| defaultDebitAccRefId string | Default Debit accRefid of the vpa
| isPrimary boolean | Whether it is primary vpa or not
|
| bankAccounts array of object | List of bank account details
| Attribute | Description |
---|
bank string | Bank Name
Example: Paytm Payments Bank
| ifsc string | Bank IFSC code
Example: PYTM0123456
| accRefId string | Bank account reference id
Example: PYTM0123456
| maskedAccountNumber string | Masked bank account number
Example: XXXXXXXX7777
| accType string | Type of bank account
Example: SAVINGS
| credsAllowed array of object | Format to capture users credential (PIN/OTP etc) for upi
| Attribute | Description |
---|
CredsAllowedDLength string | | CredsAllowedDType string | Datatype of credentials
Possible Values: Numeric
| CredsAllowedSubType string | sub type of credential block
| CredsAllowedType string | Type of the credential block
Possible Values: PIN, OTP
| dLength string | |
| name string | | mpinSet string | Whether mpin is set for this bank account or not.
| txnAllowed string | Whether txns are allowed for this bank account
Example: ALL
| branchAddress string | Bank branch address
Example: All Branches
| pgBankCode string | Bank branch code
Example: PAYTM
| logo-url string | | bankMetaData object | Bank's health related information
| Attribute | Description |
---|
perTxnLimit string | Max cap of txn amount for this bank
Example: 200000
| bankHealth object | Displays health of bank upi depnding on success rate of the bank
| Attribute | Description |
---|
category string | Category of bank upi txns
Possible values:
,
YELLOW
Show warning message
,
RED
Do not allow txns through UPI
| displayMsg string | Can be displayed in case of yellow or red category
|
|
|
| profileStatus string | User profile status
Example: ACTIVE
| upiLinkedMobNo string | Mobile number linked to upi
Example: 917777777777
| isDeviceBinded boolean | Is the upi profile binded to the device
|
| metaDetails object | | Attribute | Description |
---|
npciHealth string | Status of bank health
Possible values:
,
YELLOW
Show warning message
,
RED
Do not allow txns through UPI
| npciHealthMsg string | Can be displayed in case of yellow or red category
|
|
| priority string | For deffered flow - app team displays vpa details on teh basis of priorities
| upiOnboarding boolean | In case upi profile dosent exist or is deactivated - then the flag is set true (app shows upi onboarding button to the user for onboarding the user)
|
|
|
addMoneyPayOption object | Consists the payOption object that are applicable for add money transaction. This will be applicable if the wallet balance is insufficient.
|
Attribute | Description |
---|
paymentModes array of object | Array of different payment Modes
| Attribute | Description |
---|
paymentMode string | Possible values:
,
,
CREDIT_CARD
For Credit Card
,
DEBIT_CARD
For Paytm Wallet
,
NET_BANKING
For Net Banking
,
| displayName string | Payment mode name.
Possible Values: Paytm Payments Bank, Bhim Upi, Credit Card, Debit Card, Net Banking
| isDisabled object | This flag indicates the status of this payment mode (this object comes when this mode is disable)
| Attribute | Description |
---|
status string | | msg string | |
| payChannelOptions object | Payment Mode Channel array
| Attribute | Description |
---|
isDisabled object | This flag indicates the status of this payment channel (this object comes when this channel is disable)
| Attribute | Description |
---|
status string | | msg string | |
| hasLowSuccess object | This flag indicates the status of success rate (this object comes when success rate is low)
| Attribute | Description |
---|
status string | Success rate of this channel
| msg string | |
| iconUrl string | Payment channel icon
Example: icici.png
| isHybridDisabled boolean | Indicates whether hybird payment is allowed or not for this payChannel
| channelCode string | PayChannel's short code
Example: ANDB
| channelName string | PayChannel's name
Example: Andhra Bank
|
| feeAmount string | | taxAmount string | Any tax amount present in PCF
| totalTransactionAmount string | Total amount in case merchant is a PCF merchant and PCF is applicable
| priority string | Signifies order of display
Example: 1
| isHybridDisabled boolean | Whether hybrid payment mode is enabled or not for this paymethod
| onboarding boolean | This was used for postpaid onboarding. - currently being sent as false
|
| savedInstruments array of object | Array of saved card and other user saved instruments
| Attribute | Description |
---|
iconUrl string | Save instruments icon
Example: https://staticgw-stage1.paytm.in/25.1.0/
| supportedCardSubTypes array | Provides an identifier for various types of cards. Depending on your agreement, you can be charged differently for a different card.
Example:
CORPORATE_CARD which Indicates if the card used is a corporate card. Typically a merchant is charged differently for a prepaid card compared to a debit card.
| oneClickSupported boolean | Status of One-Click payment on this save instruments
| cardDetails object | Saved instruments details
| Attribute | Description |
---|
cardId string | Saved instruments id
Example: 201707291077050XXXXXX47678ef1041b96e6bcac3489
| cardType string | Possible values:
CREDIT_CARD
For Credit Card
,
DEBIT_CARD
For Debit Card
,
| expiryDate string | Saved instruments expiry date
Example: 022030
| firstSixDigit string | Saved card first six digits
Example: 411111
| lastFourDigit string | Saved card last four digits
Example: 1111
| status string | | cvvLength string | Saved card cvv length
Example: 3
| cvvRequired boolean | CVV status for this saved card
Example: 1
|
| issuingBank string | Issuing bank name
Example: JPMC
| isEmiAvailable boolean | Whether emi is available or not
| authModes array | Contains list of authentication modes available on that card
Possible Values: otp, pin
Example: ["otp"]
| displayName string | Saved instrument name
Example: JPMorgan Chase Bank Credit Card
| priority string | Indicates the priority to be given by front-end in displaying this card
Example: 3
| paymentOfferDetails object | | Attribute | Description |
---|
promocodeApplied string | Bank offer code
Example: BANKOFFERSPTTEST11
| promotext string | Message for this bank offer
Example: Promocode applied successfully
| instantDiscount string | Instant discount for this Bank offer
Example: 1.00
| cashbackAmount string | Cashback discount for this Bank offer
Example: 1.00
| payMethod string | Payment mode
Possible Values: DEBIT_CARD, CREDIT_CARD, NET_BANKING
| promoVisibility boolean | | responseCode string | Response code for this offer
|
| isHybridDisabled boolean | This instruments support the hybrid transaction or no
| channelCode string | Saved instrument channel short code
Example: VISA
| channelName string | Saved instrument channel name
Example: VISA Inc.
| prepaidCard boolean | Indicates if the saved card is also a Prepaid card or not
| isDisabled object | This flag indicates the status of this saved instrument (this object comes when this channel is disable)
| Attribute | Description |
---|
status string | | msg string | |
| hasLowSuccess object | This flag indicates the status of success rate (this object comes when success rate is low)
| Attribute | Description |
---|
status string | Success rate of this channel
| msg string | |
|
| activeSubscriptions array of object | List of Active Subscriptions
| Attribute | Description |
---|
accountNumber string | | accountHolderName string | | bankIFSC string | | bankName string | | savedCardId string | | subscriptionId string | | paymentMode string | |
| upiProfile object | Details of User's bank linked with VPA and health of npci
| Attribute | Description |
---|
respDetails object | User related data such as bankAccounts, profileStatus, deviceBinding etc.
| Attribute | Description |
---|
profileDetail object | User related data such as bankAccounts, profileStatus, deviceBinding etc.
| Attribute | Description |
---|
vpaDetails array of object | vpa details and its corresponding accRefId
| Attribute | Description |
---|
name string | Vpa of the user
Example: 7777777777@paytm
| defaultCreditAccRefId string | Default Credit accRefid of the vpa
| defaultDebitAccRefId string | Default Debit accRefid of the vpa
| isPrimary boolean | Whether it is primary vpa or not
|
| bankAccounts array of object | List of bank account details
| Attribute | Description |
---|
bank string | Bank Name
Example: Paytm Payments Bank
| ifsc string | Bank IFSC code
Example: PYTM0123456
| accRefId string | Bank account reference id
Example: PYTM0123456
| maskedAccountNumber string | Masked bank account number
Example: XXXXXXXX7777
| accType string | Type of bank account
Example: SAVINGS
| credsAllowed array of object | Format to capture users credential (PIN/OTP etc) for upi
| Attribute | Description |
---|
CredsAllowedDLength string | | CredsAllowedDType string | Datatype of credentials
Possible Values: Numeric
| CredsAllowedSubType string | sub type of credential block
| CredsAllowedType string | Type of the credential block
Possible Values: PIN, OTP
| dLength string | |
| name string | | mpinSet string | Whether mpin is set for this bank account or not.
| txnAllowed string | Whether txns are allowed for this bank account
Example: ALL
| branchAddress string | Bank branch address
Example: All Branches
| pgBankCode string | Bank branch code
Example: PAYTM
| logo-url string | | bankMetaData object | Bank's health related information
| Attribute | Description |
---|
perTxnLimit string | Max cap of txn amount for this bank
Example: 200000
| bankHealth object | Displays health of bank upi depnding on success rate of the bank
| Attribute | Description |
---|
category string | Category of bank upi txns
Possible values:
,
YELLOW
Show warning message
,
RED
Do not allow txns through UPI
| displayMsg string | Can be displayed in case of yellow or red category
|
|
|
| profileStatus string | User profile status
Example: ACTIVE
| upiLinkedMobNo string | Mobile number linked to upi
Example: 917777777777
| isDeviceBinded boolean | Is the upi profile binded to the device
|
| metaDetails object | | Attribute | Description |
---|
npciHealth string | Status of bank health
Possible values:
,
YELLOW
Show warning message
,
RED
Do not allow txns through UPI
| npciHealthMsg string | Can be displayed in case of yellow or red category
|
|
| priority string | For deffered flow - app team displays vpa details on teh basis of priorities
| upiOnboarding boolean | In case upi profile dosent exist or is deactivated - then the flag is set true (app shows upi onboarding button to the user for onboarding the user)
|
|
|
merchantLimitInfo object | |
Attribute | Description |
---|
merchantRemainingLimits array of object | Merchant Remaining Limits
| Attribute | Description |
---|
limitType string | Limit type
Possible Values: DAILY, WEEKLY, MONTHLY
| amount string | Limit amount value
Example: 1.00
|
| excludedPaymodes array | Excluded Paymodes
Example: ["UPI","NET_BANKING","GIFT_VOUCHER"]
| message string | |
|
promoCodeData object | Data related to promo that is provided in the request
|
Attribute | Description |
---|
promoCode string | Promo code value
Example: TESTOTBQ12
| promoCodeMsg string | Response message received from promo service
| promoCodeValid boolean | Status of this promo code
| promoCodeTypeName string | | promoMsg string | Message associated for that promocode
|
|
isOnTheFlyKycRequired boolean | Boolean flag which indicates whether min-kyc is required before txn
|
RiskConvenienceFee object | List of Risk Convenience Fees applied on abusive customer when the paymethod is Credit_card
|
Attribute | Description |
---|
payMethod string | Pay Method
Possible Values: DEBIT_CARD, CREDIT_CARD, NET_BANKING
| feePercent string | | reason string | |
|
addMoneyDestination boolean | Destination where money will be added in case of AddNPay
Example: GIFT_VOUCHER
|
mandateSupportedApps object | This field return all those upi apps which supports subscription (all apps supported for UPI intent flow)
|
Attribute | Description |
---|
name string | | handle string | | packageName string | | priority string | |
|
isCardCoft boolean | This flag indication whether card is already tokenized or not
|
isEligibleForCoft boolean | If isCardCoft is false then this flag indication whether card is eligible for coft tokenization or not
|
isCoftPaymentSupported boolean | If isCardCoft is true then this flag indication whether card is eligible to process payment or not
|