search

POSTFetch Payment Option V2 API

Use Case

  • To fetch payment options available for the transaction
  • To fetch payment options with which addition of fund is possible into customer’s Paytm wallet
  • To fetch saved cards of a customer. Along with saved cards, you also get a low success rate indicator. In case this indicator is positive, the customer should not be allowed to use the card
  • To fetch balance available in customer Paytm wallet and Paytm payments bank. Balance is only fetched, if the customer has logged into Paytm using Send and validate OTP flow with the same transaction token as being passed in this API request
  • To fetch list of top 5 netbanking options
  • BANK_MANDATE paymode is present in response only when txnToken is generated via Initiate Subscription API.

Query Params

ATTRIBUTE DESCRIPTION

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
conditional

This is the unique identifier for an order and should have same value as used in orderId of Initiate Transaction API or Initiate Subscription API.
Note: It becomes mandatory in case tokenType value is send as CHECKSUM or TXN_TOKEN in this request.
Example: OREDRID_98765

referenceId

string
conditional

This is the unique reference id and should have same value as used in Access Token API.
Note: It becomes mandatory in case tokenType value is send as ACCESS in the request.

Request Attributes

Content Type : JSON

Head

AttributeDescription
version
string
optional

Version of the API.

Example: v1

requestTimestamp
string
optional

EPOCH timestamp of the time at which request is being sent.
Example: 1588402269

channelId
string
optional

The parameter value identifies the Channel for which API call is initiated.

Possible values:
WEB
For websites, the value to be passed should be "WEB"
,
WAP
For Mobile websites/App, the value to be passed should be "WAP"
tokenType
string
mandatory

Authorization method for this request.

Possible values:
ACCESS
To be used in case authentication is done using access token.
,
TXN_TOKEN
To be used in case authentication done using transaction token.
token
string
mandatory

Authorization string corresponding to the tokenType used.

Example: 739816707d7444XXXXXXXX6cb4264d0a1590145379323

Body

AttributeDescription
origin-channel
string
optional

Channels of the merchants which are using Paytm's UPI PUSH sdk

Example: PAYTMTEST

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

deviceId
string
optional

Device Id, which will be passed to UPI in FetchProfile call and Payment call in case of Txns from UPI PUSH SDK.

Example: 9140703226

Response Attributes

Content Type : JSON

Head

AttributeDescription
version
string

Version of the API passed in the request.
Example: v1

responseTimestamp
string

EPOCH timestamp of the time at which response is being sent.
Example: 1588402269

Body

AttributeDescription
resultInfo
object

This parameter gives the information about the result of the API response

ResultInfo
+
AttributeDescription
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:
S,
For Success
F,
For Failure
U
For Unknown
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

Details of the merchant

MerchantDetails
+
AttributeDescription
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

MerchantDetails
+
AttributeDescription
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

userDetails
object

Details of the user

UserDetails
+
AttributeDescription
email
string

email address of user

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

Login details

LoginInfo
+
AttributeDescription
userLoggedIn
boolean

This flag indicates that user login status

pgAutoLoginEnabled
boolean

This flag indicates that auto-login available

mobileNumberNonEditable
string

User mobile number

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:
NONE
By Default
,
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.

PayOption
+
AttributeDescription
paymentModes
array of object

Array of different payment Modes

PayMethod
+
AttributeDescription
paymentMode
string

Mode of payment

Possible values:
BALANCE
For Paytm Wallet
,
UPI
For Bhim Upi
,
CREDIT_CARD
For Credit Card
,
DEBIT_CARD
For Paytm Wallet
,
NET_BANKING
For Net Banking
,
EMI
For Emi Options
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)

StatusInfo
+
AttributeDescription
status
string

Payment mode status

msg
string

Disable status message

payChannelOptions
array of object

Payment mode channel array

PayChannelBase
+
AttributeDescription
isDisabled
object

This flag indicates the status of this payment channel (this object comes when this channel is disable)

StatusInfo
+
AttributeDescription
status
string

Payment channel status

msg
string

Disable status message

hasLowSuccess
object

This flag indicates the status of success rate (this object comes when success rate is low)

StatusInfo
+
AttributeDescription
status
string

Success rate of this channel

msg
string

Low success rate message

iconUrl
string

Payment channel icon

Example: icici.png

minAmount
object

Minimum amount for EMI plan

Money
+
AttributeDescription
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

Money
+
AttributeDescription
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"}}

BalanceInfo
+
AttributeDescription
subWalletDetails
array of object

Basic details of Paytm sub wallet

SubWalletDetails
+
AttributeDescription
displayName
string

Paytm sub wallet name

Example: Paytm Wallet

balance
string

Paytm sub wallet balance

Example: 2.00

imageUrl
string

Paytm sub wallet icon

payerAccountExists
boolean

Status of Paytm Wallet

accountBalance
object

Total balance of Paytm wallet

Money
+
AttributeDescription
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

Post Convenience fee

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

SavedInstruments
+
AttributeDescription
iconUrl
string

Save instruments icon

Example: https://staticgw-stage1.paytm.in/25.1.0/

oneClickSupported
boolean

Status of One-Click payment on this save instruments

cardDetails
object

Saved instruments details

CardDetails
+
AttributeDescription
cardId
string

Saved instruments id

Example: 201707291077050XXXXXX47678ef1041b96e6bcac3489

cardType
string

Saved instruments type

Possible values:
CREDIT_CARD
For Credit Card
,
DEBIT_CARD
For Debit Card
,
UPI
For UPI
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

Saved instruments status

Possible values:
1
For Active
,
0
For Inactive
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

Bank offer details

PaymentOfferDetails
+
AttributeDescription
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

Status of this offer

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.

isDisabled
object

This flag indicates the status of this saved instrument (this object comes when this channel is disable)

StatusInfo
+
AttributeDescription
status
string

Payment mode status

msg
string

Disable status message

hasLowSuccess
object

This flag indicates the status of success rate (this object comes when success rate is low)

StatusInfo
+
AttributeDescription
status
string

Success rate of this channel

msg
string

Low success rate message

activeSubscriptions
array of object

List of Active Subscriptions

ActiveSubscriptions
+
AttributeDescription
accountNumber
string

Account Number

accountHolderName
string

Account holder name

bankIFSC
string

Bank IFSC code

bankName
string

Bank name

savedCardId
string

Save instruments id

subscriptionId
string

Subscription id

paymentMode
string

Payment mode

upiProfile
object

Details of User's bank linked with VPA and health of npci

UPIProfile
+
AttributeDescription
respDetails
object

User related data such as bankAccounts, profileStatus, deviceBinding etc.

RespDetails
+
AttributeDescription
profileDetail
object

User related data such as bankAccounts, profileStatus, deviceBinding etc.

ProfileDetail
+
AttributeDescription
vpaDetails
array of object

vpa details and its corresponding accRefId

VPADetails
+
AttributeDescription
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

BankAccounts
+
AttributeDescription
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

CredsAllowed
+
AttributeDescription
CredsAllowedDLength
string

Length of the credential

Possible values:
4
For PIN
,
6
For OTP
CredsAllowedDType
string

Datatype of credentials

Possible Values: Numeric

CredsAllowedSubType
string

sub type of credential block

Possible values:
MPIN,
For PIN
,
SMS
For OTP
CredsAllowedType
string

Type of the credential block

Possible Values: PIN, OTP

dLength
string

Length of the credential

Possible values:
4
For PIN
,
6
For OTP
name
string

Bank account holder name

mpinSet
string

Whether mpin is set for this bank account or not.

Possible values:
N
For No
,
Y
For Yes
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

Url for logo of the bank

bankMetaData
object

Bank's health related information

BankMetaData
+
AttributeDescription
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

BankHealth
+
AttributeDescription
category
string

Category of bank upi txns

Possible values:
GREEN
Txns are allowed
,
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

NPCI related data

BankHealth
+
AttributeDescription
npciHealth
string

Status of bank health

Possible values:
GREEN
Txns are allowed
,
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.

PayOption
+
AttributeDescription
paymentModes
array of object

Array of different payment Modes

PayMethod
+
AttributeDescription
paymentMode
string

Mode of payment

Possible values:
BALANCE
For Paytm Wallet
,
UPI
For Bhim Upi
,
CREDIT_CARD
For Credit Card
,
DEBIT_CARD
For Paytm Wallet
,
NET_BANKING
For Net Banking
,
EMI
For Emi Options
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)

StatusInfo
+
AttributeDescription
status
string

Payment mode status

msg
string

Disable status message

payChannelOptions
object

Payment Mode Channel array

PayChannelBase
+
AttributeDescription
isDisabled
object

This flag indicates the status of this payment channel (this object comes when this channel is disable)

StatusInfo
+
AttributeDescription
status
string

Payment channel status

msg
string

Disable status message

hasLowSuccess
object

This flag indicates the status of success rate (this object comes when success rate is low)

StatusInfo
+
AttributeDescription
status
string

Success rate of this channel

msg
string

Low success rate message

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

Post Convenience fee

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

SavedInstruments
+
AttributeDescription
iconUrl
string

Save instruments icon

Example: https://staticgw-stage1.paytm.in/25.1.0/

oneClickSupported
boolean

Status of One-Click payment on this save instruments

cardDetails
object

Saved instruments details

CardDetails
+
AttributeDescription
cardId
string

Saved instruments id

Example: 201707291077050XXXXXX47678ef1041b96e6bcac3489

cardType
string

Saved instruments type

Possible values:
CREDIT_CARD
For Credit Card
,
DEBIT_CARD
For Debit Card
,
UPI
For UPI
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

Saved instruments status

Possible values:
1
For Active
,
0
For Inactive
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

Bank offer details

PaymentOfferDetails
+
AttributeDescription
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

Status of this offer

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.

isDisabled
object

This flag indicates the status of this saved instrument (this object comes when this channel is disable)

StatusInfo
+
AttributeDescription
status
string

Payment mode status

msg
string

Disable status message

hasLowSuccess
object

This flag indicates the status of success rate (this object comes when success rate is low)

StatusInfo
+
AttributeDescription
status
string

Success rate of this channel

msg
string

Low success rate message

activeSubscriptions
array of object

List of Active Subscriptions

ActiveSubscriptions
+
AttributeDescription
accountNumber
string

Account Number

accountHolderName
string

Account holder name

bankIFSC
string

Bank IFSC code

bankName
string

Bank name

savedCardId
string

Save instruments id

subscriptionId
string

Subscription id

paymentMode
string

Payment mode

upiProfile
object

Details of User's bank linked with VPA and health of npci

UPIProfile
+
AttributeDescription
respDetails
object

User related data such as bankAccounts, profileStatus, deviceBinding etc.

RespDetails
+
AttributeDescription
profileDetail
object

User related data such as bankAccounts, profileStatus, deviceBinding etc.

ProfileDetail
+
AttributeDescription
vpaDetails
array of object

vpa details and its corresponding accRefId

VPADetails
+
AttributeDescription
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

BankAccounts
+
AttributeDescription
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

CredsAllowed
+
AttributeDescription
CredsAllowedDLength
string

Length of the credential

Possible values:
4
For PIN
,
6
For OTP
CredsAllowedDType
string

Datatype of credentials

Possible Values: Numeric

CredsAllowedSubType
string

sub type of credential block

Possible values:
MPIN,
For PIN
,
SMS
For OTP
CredsAllowedType
string

Type of the credential block

Possible Values: PIN, OTP

dLength
string

Length of the credential

Possible values:
4
For PIN
,
6
For OTP
name
string

Bank account holder name

mpinSet
string

Whether mpin is set for this bank account or not.

Possible values:
N
For No
,
Y
For Yes
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

Url for logo of the bank

bankMetaData
object

Bank's health related information

BankMetaData
+
AttributeDescription
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

BankHealth
+
AttributeDescription
category
string

Category of bank upi txns

Possible values:
GREEN
Txns are allowed
,
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

NPCI related data

BankHealth
+
AttributeDescription
npciHealth
string

Status of bank health

Possible values:
GREEN
Txns are allowed
,
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

Merchant limit info

MerchantLimitInfo
+
AttributeDescription
merchantRemainingLimits
array of object

Merchant Remaining Limits

MerchantRemainingLimits
+
AttributeDescription
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

Message for this limits

promoCodeData
object

Data related to promo that is provided in the request

PromoCodeData
+
AttributeDescription
promoCode
string

Promo code value

Example: TESTOTBQ12

promoCodeMsg
string

Response message received from promo service

promoCodeValid
boolean

Status of this promo code

promoCodeTypeName
string

Type of promo code

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

RiskConvenienceFee
+
AttributeDescription
payMethod
string

Pay Method

Possible Values: DEBIT_CARD, CREDIT_CARD, NET_BANKING

feePercent
string

Fee Percent

Example: 2

reason
string

Reason

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)

MandateSupportedApps
+
AttributeDescription
name
string

Name of app

handle
string

Handle of app

packageName
string

Package name of app

priority
string

Priority of this App

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
400FInvalid Id supplied
1006FSession expired
3001FException in Payment RequestProcessing
00000900USystem error
Staging
Production
https://securegw-stage.paytm.in/theia/api/v2/fetchPaymentOptions?mid={mid}&orderId=ORDERID_98765copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://securegw-stage.paytm.in/theia/api/v2/fetchPaymentOptions?mid={mid}&orderId=ORDERID_98765' \
--header 'Content-Type: application/json' \
--data '{"head":{"tokenType":"TXN_TOKEN","token":"f0bed899539742309eebd8XXXX7edcf61588842333227"},"body":{"mid":"{mid}"}}'
copy icon