Fetch EMI API

Checksum required: No

Use Case


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


Request Attributes

API Content format: JSON

Head

ATTRIBUTEDESCRIPTIONMANDATORY
versionstringApplication version(provided by paytm)No
channelIdStringChannel through which call initiated
WEB: Web server, WAP: Mobile device
No
requestTimestampstringUNIX timestamp of the time request is being sentNo
txnTokenstringUnique Transaction Token generated in initiateTransactionCall to PG. Merchant has to send back the same transaction token everytime in each subsequent API Call to communicate with PGYes

Body

ATTRIBUTEDESCRIPTIONMANDATORY
channelCode stringChannel Code for which you need to fetch EMI details.Yes
amount MoneyTransaction Amount and the currency valueNo

Response Attributes

Head

ATTRIBUTEDESCRIPTIONMANDATORY
responseTimestamp stringTimestamp at which response was sentYes
version stringApplication versionNo

Body

ATTRIBUTEDESCRIPTIONMANDATORY
resultInfo ResultInfoResult Info of API callYes
emiDetail EmiChannel EMI details about channelYes
extraParamsMap Map<String, Object>Map for any Extra informationfalse

Money

ATTRIBUTEDESCRIPTIONMANDATORY
currency String (3)Currency Code (INR)Yes
value String (regexp = [0-9]+([.][0-9]{1, 2})?, length less than 16 characters)Transaction value upto decimalYes

EmiChannel

ATTRIBUTEDESCRIPTIONMANDATORY
emiChannelInfosList of available EMI Plan IdsYes
emiHybridChannelInfosList of available EMI Plan Ids for Hybrid TransactionNo
emiTypeType of EMINo

EMIChannelInfo

ATTRIBUTEDESCRIPTIONMANDATORY
planId StringThis is the plan which the bank offers.Yes
interestRate StringInterest rate of the EMI plan.Yes
ofMonths StringThis is the months plan of EMI.Yes
minAmount MoneyThe minimum amount needed for the planId.Yes
maxAmount MoneyThe maximum amount needed for the planId.Yes
emiAmount MoneyThis is an additonal amount for EMI.Yes
totalAmount MoneyTotal amount with EMI amount added.Yes

ResultInfo

ATTRIBUTEDESCRIPTIONMANDATORY
resultCodeStringResult code returned to merchant . Max length of result code can be 64Yes
resultStatusStringStatus of API call
(S:Success, F:Faliure, U:Unknown)
Yes
resultMsgString(256)Result Message contains information about the result.Yes

Response Code and Message

resultCoderesultStatusresultMsg
0000SSuccess
1001FRequest prameters are not valid
1006FSession Expired Exception
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
00000900USystem error

Endpoints

Staging: https://securegw-stage.paytm.in/theia/api/v1/fetchEMIDetail?mid=<mid>&orderId=<orderId>

Production: https://securegw.paytm.in/theia/api/v1/fetchEMIDetail?mid=<mid>&orderId=<orderId>

Request CodeResponse JSON
curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/fetchEMIDetail?mid=xxxxxxxxxxxxxxxxxxxx&orderId=xxxxxxxxxxxxxxxxxxxx' --header 'Content-Type: application/json' --data '{"head":{"version":"v1","requestTimestamp":1555169564,"channelId":"WEB","txnToken":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},"body":{"channelCode":"HDFC,AMEX"}}'