POSTFetch EMI Detail API

Use Case

This API fetches the list of emi details like tenure, interest rates, min and max amount for requested channel configured for given MID

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. Example:f0bed899539742309eebd8XXXX7edcf61588842333227

Body

Attribute

Description

channelCode

string

mandatory

Channel Code for which you need to fetch EMI details.

Possible Values: HDFC, AMEX, ICICI, IDBI etc.
List of Bank Codes (Channel).

amount

object

optional

Transaction Amount and the currency value.

Money

Attribute	Description
value string mandatory	This parameter contains the amount to be charged to the customer and can have two places of decimal. Example: 1.00
currency string mandatory	This parameter indicates the currency in which transaction amount is to be deducted. Possible Values: INR

emiType

string

conditional

Mandatory, in case merchant wants to fetch EMI plans for a Debit Card bank

Possible: DEBIT_CARD, CREDIT_CARD

originalAmount

string

conditional

The original price/value of the cart before discount is applied

applicableTenures

Array of string

conditional

The tenures on which the promocode is applicable.

Possible values = [] and[ 3,6,9] etc

If applicable tenures = [], then the offer is applicable on all tenures configured for merchant

Response Attributes

Content Type : JSON

Head

Attribute	Description
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, F, U
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.

emiDetail

object

EMI details about channel

EmiChannel

Attribute

Description

emiChannelInfos

object

List of available EMI Plan Ids.

EMIChannelInfo

Attribute

Description

planId

string

This is the plan which the bank offers.

Example: ICICI|3

interestRate

string

Interest rate of the EMI plan.

Example: 4.50

ofMonths

string

This is the months plan of EMI.

Example: 3.00

minAmount

object

The minimum amount needed for the planId.

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

The maximum amount needed for the planId.

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

emiAmount

object

This is an additonal amount for EMI.

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

totalAmount

object

Total amount with EMI amount added.

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

processingFee

string

Processing Fee

apr

double

Annual Percentage Rate

emiHybridChannelInfos

object

List of available EMI Plan Ids for Hybrid Transaction.

EMIChannelInfo

Attribute

Description

planId

string

This is the plan which the bank offers.

Example: ICICI|3

interestRate

string

Interest rate of the EMI plan.

Example: 4.50

ofMonths

string

This is the months plan of EMI.

Example: 3.00

minAmount

object

The minimum amount needed for the planId.

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

The maximum amount needed for the planId.

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

emiAmount

object

This is an additonal amount for EMI.

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

totalAmount

object

Total amount with EMI amount added.

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

processingFee

string

Processing Fee

apr

double

Annual Percentage Rate

emiType

string

Type of EMI

isHybridDisabled

boolean

Indicates whether the hybrid payment is allowed or not for this EMI option.

extraParamsMap

object

Map for any extra information (in case of error).

Response Codes & Messages

resultCode	resultStatus	resultMsg
0000	S	Success
1001	F	Request parameters are not valid
1006	F	Session Expired Exception
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
00000900	U	System error

⇾

Staging

Production

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

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securestage.paytmpayments.com/theia/v1/fetchEMIDetail?mid={mid}&orderId=ORDERID_98765' \
--header 'Content-Type: application/json' \
--data '{"head":{"txnToken":"f0bed899539742309eebd8XXXX7edcf61588842333227"},"body":{"channelCode":"ICICI"}}'