search

POSTFetch Payment Options API

Use Case

To fetch payment options available for the transaction.

Request Attributes

Content Type : JSON

Head

AttributeDescription
channelId
EChannelId
optional

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

token
string
mandatory

This is the unique transaction token
 

Example: ede0b9a1-e30d-4fa0-89fb-68221c3e9ff6

tokenType
TokenType
mandatory

This parameter identifies whether the API works on checksum authentication. 

Possible Values: CHECKSUM, JWT

requestTimestamp
string
optional

Request time in mili-seconds.
 

Example: 1588402269

Body

AttributeDescription
mid
string
mandatory

Paytm provides MID as a unique identifier to each merchant

orderId
string
mandatory

The Unique reference ID of the Order. It is alphanumeric and the max length is 50 characters.

Example: AOA001115. 
 

Response Attributes

Content Type : JSON

Head

AttributeDescription
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
resultStatus
string

This parameter is the result specific to the phase of the transaction mentioned in the txnType field

resultCode
string

This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64.

resultMsg
string

This parameter is the result message which contains information about the result.

groupPayOptionsPriorities
Map<String, Integer>

Priorities of payment options

 

Examples: paytm_featured, savedInstruments, other_options

groupedMerchantPayOption
string

Consists of the payment modes that are available on the merchant. Additionally, it contains of a list of saved cards saved against a customer

GroupedMerchantPayOptionResponse
+
AttributeDescription
paytm_featured
List <PaymentMethod>

paytm featured payModes like Paytm Wallet, POSTPAID, PPBL

PaymentMethod
+
AttributeDescription
displayName
string

Payment mode name

 

Possible Values: Paytm Balance, Paytm Payments Bank, Bhim UPI, Credit Card, Debit Card, Net Banking, EMI

payChannelOptions
List <PayChannelOption>

Payment mode channel List

PayChannelOption
+
AttributeDescription
iconUrl
string

Payment channel icon

bankLogoUrl
string

Issuing Bank logo icon

channelCode
string

Issuing bank code

channelName
string

Name of channel Code.

minAmount
string

The minimum amount needed for the planId. (In case of EMI Only)

Amount
+
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
string

The maximum amount needed for the planId. (In case of EMI Only)

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

cardType
string

Type of card. (In case of EMI Only)

 

Possible Values: CREDIT_CARD, DEBIT_CARD

channelDisplayName
string

Display name of channel code. (In case of EMI Only)

balanceInfo
string

Basic details of Paytm wallet. (In case of Wallet, PPBL, Postpaid Only)

AccountBalanceInfo
+
AttributeDescription
accountBalance
string

Total balance, in case of Wallet, PPBL, Postpaid.

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

status
string

This flag indicates the status of this payment mode. (In case of Wallet, PPBL, Postpaid Only)

AccountStatusInfo
+
AttributeDescription
isDisabled
string

Payment channel status

msg
string

Disable status message

userAccountExists
string

Status of user account.

 

Possible Values: true/false

merchantAccepts
string

Status of merchant accepts this pay mode.

 

Possible Values: true/false

priority
string

Signifies order of display

prepaidCardSupported
boolean

Indicates if prepaid card is configured on the merchant

paymentMode
PayMethod

Mode of payment

 

Possible Values: BALANCE, UPI, CREDIT_CARD, DEBIT_CARD, NTE_BANKING, EMI

other_options
List <PaymentMethod>

Other PayModes like cards, NB, UPI etc.

PaymentMethod
+
AttributeDescription
displayName
string

Payment mode name

 

Possible Values: Paytm Balance, Paytm Payments Bank, Bhim UPI, Credit Card, Debit Card, Net Banking, EMI

payChannelOptions
List <PayChannelOption>

Payment mode channel List

PayChannelOption
+
AttributeDescription
iconUrl
string

Payment channel icon

bankLogoUrl
string

Issuing Bank logo icon

channelCode
string

Issuing bank code

channelName
string

Name of channel Code.

minAmount
string

The minimum amount needed for the planId. (In case of EMI Only)

Amount
+
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
string

The maximum amount needed for the planId. (In case of EMI Only)

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

cardType
string

Type of card. (In case of EMI Only)

 

Possible Values: CREDIT_CARD, DEBIT_CARD

channelDisplayName
string

Display name of channel code. (In case of EMI Only)

balanceInfo
string

Basic details of Paytm wallet. (In case of Wallet, PPBL, Postpaid Only)

AccountBalanceInfo
+
AttributeDescription
accountBalance
string

Total balance, in case of Wallet, PPBL, Postpaid.

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

status
string

This flag indicates the status of this payment mode. (In case of Wallet, PPBL, Postpaid Only)

AccountStatusInfo
+
AttributeDescription
isDisabled
string

Payment channel status

msg
string

Disable status message

userAccountExists
string

Status of user account.

 

Possible Values: true/false

merchantAccepts
string

Status of merchant accepts this pay mode.

 

Possible Values: true/false

priority
string

Signifies order of display

prepaidCardSupported
boolean

Indicates if prepaid card is configured on the merchant

paymentMode
PayMethod

Mode of payment

 

Possible Values: BALANCE, UPI, CREDIT_CARD, DEBIT_CARD, NTE_BANKING, EMI

savedInstruments
string

It contains list of saved cards saved against a customer for that merchant

SaveTokenizedCard
+
AttributeDescription
corporateCard
boolean

Identifier for Corporate Card

cardDetails
string

Saved instruments details

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

isEmiAvailable
boolean

Whether emi is available or not

authModes
List <String>

Contains list of authentication modes available on that card
 

Possible Values: OTP

displayName
string

Saved instrument name

priority
string

Indicates the priority to be given by front-end in displaying this card

 

Example: 3

prepaidCard
boolean

Indicates if the saved card is also a Prepaid card or not

bankName
string

Bank name

cardType
string

type of card (CC or DC)

par
string

unique reference for card by card network

tokenStatus
string

status of token maintained by PTS

gcin
string

Global Card Index Number

isEligibleForCoft
boolean

True if particular scheme is eligible for coft

isCoftPaymentSupported
boolean

States whether token Payment is supported or not

groupedAddMoneyPayOption
string

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

GroupedMerchantPayOptionResponse
+
AttributeDescription
paytm_featured
List <PaymentMethod>

paytm featured payModes like Paytm Wallet, POSTPAID, PPBL

PaymentMethod
+
AttributeDescription
displayName
string

Payment mode name

 

Possible Values: Paytm Balance, Paytm Payments Bank, Bhim UPI, Credit Card, Debit Card, Net Banking, EMI

payChannelOptions
List <PayChannelOption>

Payment mode channel List

PayChannelOption
+
AttributeDescription
iconUrl
string

Payment channel icon

bankLogoUrl
string

Issuing Bank logo icon

channelCode
string

Issuing bank code

channelName
string

Name of channel Code.

minAmount
string

The minimum amount needed for the planId. (In case of EMI Only)

Amount
+
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
string

The maximum amount needed for the planId. (In case of EMI Only)

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

cardType
string

Type of card. (In case of EMI Only)

 

Possible Values: CREDIT_CARD, DEBIT_CARD

channelDisplayName
string

Display name of channel code. (In case of EMI Only)

balanceInfo
string

Basic details of Paytm wallet. (In case of Wallet, PPBL, Postpaid Only)

AccountBalanceInfo
+
AttributeDescription
accountBalance
string

Total balance, in case of Wallet, PPBL, Postpaid.

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

status
string

This flag indicates the status of this payment mode. (In case of Wallet, PPBL, Postpaid Only)

AccountStatusInfo
+
AttributeDescription
isDisabled
string

Payment channel status

msg
string

Disable status message

userAccountExists
string

Status of user account.

 

Possible Values: true/false

merchantAccepts
string

Status of merchant accepts this pay mode.

 

Possible Values: true/false

priority
string

Signifies order of display

prepaidCardSupported
boolean

Indicates if prepaid card is configured on the merchant

paymentMode
PayMethod

Mode of payment

 

Possible Values: BALANCE, UPI, CREDIT_CARD, DEBIT_CARD, NTE_BANKING, EMI

other_options
List <PaymentMethod>

Other PayModes like cards, NB, UPI etc.

PaymentMethod
+
AttributeDescription
displayName
string

Payment mode name

 

Possible Values: Paytm Balance, Paytm Payments Bank, Bhim UPI, Credit Card, Debit Card, Net Banking, EMI

payChannelOptions
List <PayChannelOption>

Payment mode channel List

PayChannelOption
+
AttributeDescription
iconUrl
string

Payment channel icon

bankLogoUrl
string

Issuing Bank logo icon

channelCode
string

Issuing bank code

channelName
string

Name of channel Code.

minAmount
string

The minimum amount needed for the planId. (In case of EMI Only)

Amount
+
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
string

The maximum amount needed for the planId. (In case of EMI Only)

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

cardType
string

Type of card. (In case of EMI Only)

 

Possible Values: CREDIT_CARD, DEBIT_CARD

channelDisplayName
string

Display name of channel code. (In case of EMI Only)

balanceInfo
string

Basic details of Paytm wallet. (In case of Wallet, PPBL, Postpaid Only)

AccountBalanceInfo
+
AttributeDescription
accountBalance
string

Total balance, in case of Wallet, PPBL, Postpaid.

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

status
string

This flag indicates the status of this payment mode. (In case of Wallet, PPBL, Postpaid Only)

AccountStatusInfo
+
AttributeDescription
isDisabled
string

Payment channel status

msg
string

Disable status message

userAccountExists
string

Status of user account.

 

Possible Values: true/false

merchantAccepts
string

Status of merchant accepts this pay mode.

 

Possible Values: true/false

priority
string

Signifies order of display

prepaidCardSupported
boolean

Indicates if prepaid card is configured on the merchant

paymentMode
PayMethod

Mode of payment

 

Possible Values: BALANCE, UPI, CREDIT_CARD, DEBIT_CARD, NTE_BANKING, EMI

savedInstruments
string

It contains list of saved cards saved against a customer for that merchant

SaveTokenizedCard
+
AttributeDescription
corporateCard
boolean

Identifier for Corporate Card

cardDetails
string

Saved instruments details

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

isEmiAvailable
boolean

Whether emi is available or not

authModes
List <String>

Contains list of authentication modes available on that card
 

Possible Values: OTP

displayName
string

Saved instrument name

priority
string

Indicates the priority to be given by front-end in displaying this card

 

Example: 3

prepaidCard
boolean

Indicates if the saved card is also a Prepaid card or not

bankName
string

Bank name

cardType
string

type of card (CC or DC)

par
string

unique reference for card by card network

tokenStatus
string

status of token maintained by PTS

gcin
string

Global Card Index Number

isEligibleForCoft
boolean

True if particular scheme is eligible for coft

isCoftPaymentSupported
boolean

States whether token Payment is supported or not

merchantDetails
string

Details of merchant

MerchantInfo
+
AttributeDescription
merchantName
string

Name of the merchant

merchantDisplayName
string

Display Name of the merchant

merchantLogo
string

Merchant profile image URL

qrDetail
object

Contains QR Details 

QRDetails
+
AttributeDescription
dataUrl
string

Contains QR data

pageTimeout
long

QR expiry time

enabled
boolean

It indicates whether QR is enabled on merchant, it is always set as true as of now

upiQR
boolean

Indicates it is UPI QR
Always true for UPI Dynamic QR
 

loginInfo
string

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/UI will need to append the same before every iconUrl.

orderAmount
string

Value of order/order Amount

paymentFlow
string

Payment flow applied on merchant

 

Possible values: NONE , ADDNPAY

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
501FSystem error
1007FMissing mandatory element
1001FRequest parameters are not valid
1006FYour Session has expired
2013FMid in the query param doesn't match with the Mid send in the request
2014FOrderId in the query param doesn't match with the OrderId send in the request
1001FParameter illegal Note: If the value is not allowed in request parameters then the result message should be in the format of "Invalid {field name}" For example: Invalid tokenType, etc
2222FInvalid request body
Staging
Production
https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchPaymentOptions?mid={{mid}}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location 'https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchPaymentOptions?mid={{mid}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data '{"head": {"tokenType": "TXN_TOKEN","token": "a7bc0582-bbe2-4f63-893c-ea89efbc4b07","channelId": "WEB"},"body": {"mid": "{{mid}}","orderId": "{{orderId}}"}}'

 

copy icon