POSTFetch Payment Option 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.

Request Attributes

Content Type : JSON

Head

Attribute	Description
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"
txnToken string mandatory	This is the unique transaction token received in the response of Initiate Transaction API or Initiate Subscription API. It is valid for 15 minutes.

Response Attributes

Content Type : JSON

Head

Attribute	Description
requestId string	Unique reference ID which is given in request payload
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

Attribute

Description

resultInfo

object

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

ResultInfo

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: 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 whether retry is allowed or not.

merchantDetails

object

Details of the merchant

MerchantDetails

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

MerchantDetails

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

userDetails

object

Details of the user

UserDetails

Attribute	Description
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

LoginInfo

Attribute	Description
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: 8b689268565345a68XXXXXXXXXXeaf2f1589373798051

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

Attribute

Description

paymentModes

array of object

Array of different payment Modes

PayMethod

Attribute

Description

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 Modes’ name. Note that these names should be used as display names

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

StatusInfo

Attribute	Description
status string	Payment mode status
msg string	Disable status message

payChannelOptions

array of object

Payment Mode Channel array

PayChannelBase

Attribute

Description

isDisabled

object

This flag indicates the status of this payment channel

StatusInfo

Attribute	Description
status string	Payment channel status
msg string	Disable status message

hasLowSuccess

object

This flag indicates the status of success rate

StatusInfo

Attribute	Description
status string	Success rate of this channel
msg string	Low success rate message

iconUrl

string

Icon Url of the channel

minAmount

object

Minimum amount for EMI plan

Money

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

Money

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"}}

BalanceInfo

Attribute

Description

subWalletDetails

array of object

Basic details of Paytm sub wallet

SubWalletDetails

Attribute	Description
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

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

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

savedInstruments

array of object

Array of saved card and other user saved instruments

SavedInstruments

Attribute

Description

iconUrl

string

Save instruments icon

Example: https://staticgw-stage1.paytmpayments.com/25.1.0/

oneClickSupported

boolean

Status of One-Click payment on this save instruments

cardDetails

object

Saved instruments details

CardDetails

Attribute	Description
cardId string	Saved instruments id Example: 6c11070XXXXXX1b9cac3489
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

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	Status of this offer
responseCode string	Response code for this offer

isHybridDisabled

boolean

This instruments support the hybrid transaction or not

channelCode

string

Saved instrument channel short code

Example: VISA

channelName

string

Saved instrument channel name

Example: VISA Inc.

activeSubscriptions

array of object

List of Active Subscriptions

ActiveSubscriptions

Attribute	Description
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

userProfileSarvatra

object

Merchant VPA account details

UserProfileSarvatra

Attribute

Description

status

string

Status of merchant VPA account

Possible Values: success, failure

response

object

Merchant VPA details

Response

Attribute

Description

vpaDetails

object

Merchant VPA details

VpaDetails

Attribute

Description

name

string

VPA name

Example: 7777777777@paytm

defaultCredit

object

Mapped account detail with VPA for credit

DefaultCredit

Attribute

Description

bank

string

Bank Name

Example: Paytm Payments Bank

ifsc

string

Bank IFSC code

Example: PYTM0123456

account

string

Bank account number

accRefNumber

string

Bank account reference number

accountType

string

Bank account type

Example: SAVINGS

credsAllowed

object

Account option

CredsAllowed

Attribute	Description
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

mbeba

string

Bank account require data

Possible values:

For yes

For no

aeba

string

Bank account require data

Possible values:

For yes

For no

accRefId

string

Bank account reference id

Example: 9690138

maskedAccountNumber

string

Masked bank account number

Example: XXXXXXXX7777

mmid

string

Bank account require data

invalidVpa

string

Status of vpa account

defaultDebit

object

Mapped account detail with VPA for debit

DefaultDebit

Attribute

Description

bank

string

Bank Name

Example: Paytm Payments Bank

ifsc

string

Bank IFSC code

Example: PYTM0123456

account

string

Bank account number

accRefNumber

string

Bank account reference number

accountType

string

Bank account type

Example: SAVINGS

credsAllowed

object

Account option

CredsAllowed

Attribute	Description
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

mbeba

string

Bank account required data

Possible values:

For yes

For no

aeba

string

Bank account required data

Possible values:

For yes

For no

accRefId

string

Bank account reference id

Example: 9690138

maskedAccountNumber

string

Masked bank account number

Example: XXXXXXXX7777

mmid

string

Bank account required data

invalidVpa

string

Status of vpa account

priority

string

Priority of this VPA address

bankAccounts

object

Merchant bank account details

BankAccounts

Attribute

Description

bank

string

Bank Name

Example: Paytm Payments Bank

ifsc

string

Bank IFSC code

Example: PYTM0123456

account

string

Bank account number

accRefNumber

string

Bank account reference number

accountType

string

Bank account type

Example: SAVINGS

credsAllowed

object

Account option

CredsAllowed

Attribute	Description
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

mbeba

string

Bank account require data

Possible values:

For yes

For no

aeba

string

Bank account require data

Possible values:

For yes

For no

accRefId

string

Bank account reference id

Example: 9690138

maskedAccountNumber

string

Masked bank account number

Example: XXXXXXXX7777

mmid

string

Bank account require data

invalidVpa

string

Status of vpa account

addMoneyPayOption

object

Consists the payOption object that are applicable for add money transaction. This will be applicable if the wallet balance is insufficient.

PayOption

Attribute

Description

paymentModes

array of object

Array of different payment Modes

PayMethod

Attribute

Description

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 Modes’ name. Note that these names should be used as display names

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

StatusInfo

Attribute	Description
status string	Payment mode status
msg string	Disable status message

payChannelOptions

array of object

Payment Mode Channel array

PayChannelBase

Attribute

Description

isDisabled

object

This flag indicates the status of this payment channel

StatusInfo

Attribute	Description
status string	Payment channel status
msg string	Disable status message

hasLowSuccess

object

This flag indicates the status of success rate

StatusInfo

Attribute	Description
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

savedInstruments

array of object

Array of saved card and other user saved instruments

SavedInstruments

Attribute

Description

iconUrl

string

Save instruments icon

Example: https://staticgw-stage1.paytmpayments.com/25.1.0/

oneClickSupported

boolean

Status of One-Click payment on this save instruments

cardDetails

object

Saved instruments details

CardDetails

Attribute	Description
cardId string	Saved instruments id Example: 6c11070XXXXXX1b9cac3489
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

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	Status of this offer
responseCode string	Response code for this offer

isHybridDisabled

boolean

This instruments support the hybrid transaction or not

channelCode

string

Saved instrument channel short code

Example: VISA

channelName

string

Saved instrument channel name

Example: VISA Inc.

activeSubscriptions

array of object

List of Active Subscriptions

ActiveSubscriptions

Attribute	Description
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

userProfileSarvatra

object

Merchant VPA account details

UserProfileSarvatra

Attribute

Description

status

string

Status of merchant VPA account

Possible Values: success, failure

response

object

Merchant VPA details

Response

Attribute

Description

vpaDetails

object

Merchant VPA details

VpaDetails

Attribute

Description

name

string

VPA name

Example: 7777777777@paytm

defaultCredit

object

Mapped account detail with VPA for credit

DefaultCredit

Attribute

Description

bank

string

Bank Name

Example: Paytm Payments Bank

ifsc

string

Bank IFSC code

Example: PYTM0123456

account

string

Bank account number

accRefNumber

string

Bank account reference number

accountType

string

Bank account type

Example: SAVINGS

credsAllowed

object

Account option

CredsAllowed

Attribute	Description
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

mbeba

string

Bank account require data

Possible values:

For yes

For no

aeba

string

Bank account require data

Possible values:

For yes

For no

accRefId

string

Bank account reference id

Example: 9690138

maskedAccountNumber

string

Masked bank account number

Example: XXXXXXXX7777

mmid

string

Bank account require data

invalidVpa

string

Status of vpa account

defaultDebit

object

Mapped account detail with VPA for debit

DefaultDebit

Attribute

Description

bank

string

Bank Name

Example: Paytm Payments Bank

ifsc

string

Bank IFSC code

Example: PYTM0123456

account

string

Bank account number

accRefNumber

string

Bank account reference number

accountType

string

Bank account type

Example: SAVINGS

credsAllowed

object

Account option

CredsAllowed

Attribute	Description
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

mbeba

string

Bank account required data

Possible values:

For yes

For no

aeba

string

Bank account required data

Possible values:

For yes

For no

accRefId

string

Bank account reference id

Example: 9690138

maskedAccountNumber

string

Masked bank account number

Example: XXXXXXXX7777

mmid

string

Bank account required data

invalidVpa

string

Status of vpa account

priority

string

Priority of this VPA address

bankAccounts

object

Merchant bank account details

BankAccounts

Attribute

Description

bank

string

Bank Name

Example: Paytm Payments Bank

ifsc

string

Bank IFSC code

Example: PYTM0123456

account

string

Bank account number

accRefNumber

string

Bank account reference number

accountType

string

Bank account type

Example: SAVINGS

credsAllowed

object

Account option

CredsAllowed

Attribute	Description
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

mbeba

string

Bank account require data

Possible values:

For yes

For no

aeba

string

Bank account require data

Possible values:

For yes

For no

accRefId

string

Bank account reference id

Example: 9690138

maskedAccountNumber

string

Masked bank account number

Example: XXXXXXXX7777

mmid

string

Bank account require data

invalidVpa

string

Status of vpa account

merchantLimitInfo

object

Merchant limit info

MerchantLimitInfo

Attribute

Description

merchantRemainingLimits

array of object

Merchant Remaining Limits

MerchantRemainingLimits

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

Message for this limits

promoCodeData

object

Data related to promo that is provided in the request

PromoCodeData

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	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

Attribute	Description
payMethod string	Pay Method Possible Values: DEBIT_CARD, CREDIT_CARD, NET_BANKING
feePercent string	Fee Percent Example: 2
reason string	Reason

addMoneyDestination

boolean

A destination where the money will be added in case of AddNPay

Example: GIFT_VOUCHER

mandateSupportedApp

object

Mandate Supported Apps

MandateSupportedApps

Attribute	Description
name string	App Name
App Name string	App handler
packageName string	App package name
priority string	Priority of this App

Response Codes & Messages

resultCode	resultStatus	resultMsg
0000	S	Success
400	F	Invalid Id supplied
1001	F	Depending upon the use case the result message could be one from the following list: Mid is blank. Guest token is not supported
1006	F	Your Session has expired
2004	F	SSO Token is invalid
2013	F	Mid in the query param doesn't match with the Mid send in the request
2014	F	OrderId in the query param doesn't match with the OrderId send in the request
3001	F	Exception in Payment RequestProcessing
00000900	U	System error

⇾

Staging

Production

https://securestage.paytmpayments.com/fetchPaymentOptions?mid={mid}&orderId={order-id} copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securestage.paytmpayments.com/fetchPaymentOptions?mid={mid}&orderId=ORDERID_98765' \
--header 'Content-Type: application/json' \
--data '{"head":{"txnToken":"f0bed899539742309eebd8XXXX7edcf61588842333227"}}'