Fetch EMI API

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

PARAMETERDESCRIPTIONMANDATORY
versionstringApplication version(provided by paytm)Yes
channelIdString (WEB(for web server), WAP(for mobile device))Channel through which call initiatedYes
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

PARAMETERDESCRIPTIONMANDATORY
channelCode stringChannel Code for which you need to fetch EMI details.YES
amount MoneyTransaction Amount and the currency valueNO

Response Attributes:

API Content format: JSON

Header

PARAMETERDESCRIPTIONMANDATORY
responseTimestamp stringTimestamp at which response was sentYes
version stringApplication versionYes

Body

PARAMETERDESCRIPTIONMANDATORY
resultInfo ResultInfoResult Info of API callYES
emiDetail EmiChannel EMI details about channelYES
extraParamsMap Map<String, Object>Map for any Extra informationfalse

Money

PARAMETERDESCRIPTIONMANDATORY
currency string (length = 3)Currency Code (INR)YES
value string (regexp = [0-9]+([.][0-9]{1, 2})?, length less than 16 characters)Transaction value upto decimalYES

ResultInfo

PARAMETERDESCRIPTIONMANDATORY
resultStatusString (S(Success), F(Failure), U(Unknown))Status of API callYes
resultCodestringResult code returned to merchant . Max length of result code can be 64Yes
resultMsgstring (Max length can be 256])Result Message contains information about the result.Yes

EmiChannel

PARAMETERDESCRIPTIONMANDATORY
emiChannelInfosList of available EMI Plan IdsYES
emiHybridChannelInfosList of available EMI Plan Ids for Hybrid TransactionNo
emiTypeType of EMINo

EMIChannelInfo

PARAMETERDESCRIPTIONMANDATORY
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

EMIChannelInfo

PARAMETERDESCRIPTION
status StringStatus of Payment Channel
msg StringMessage contains info about status

Fetch EMI Response Code, Message and description

PARAMETERDESCRIPTIONMANDATORY
1001Request prameters are not validmid and orderId is invalid/null
1006Session Expired ExceptiontxnToken sent in request has expired or is invalid
2013Mid in the query param doesn’t match with the Mid send in the requestDifferent mid's sent in initiate transaction request and fetchEMIDetailsRequest
2014OrderId in the query param doesn’t match with the OrderId send in the requestDifferent orderId's sent in initiate transaction request and fetchEMIDetailsRequest
00000900System errorSystem error
0000SuccessSuccess

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