search

POSTTenures API - EMI Subvention

Use Case

Purpose of this API is to provide the list of EMI plans, grouped by EMI-type (standard/subvention) available for the bank code and card type present in request.

Request Attributes

Content Type : JSON

Head

AttributeDescription
channelId
string(3)
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"
requestId
string(32)
mandatory

Unique reference ID for a transaction which is generated by merchant and sent in the request

requestTimestamp
string(15)
mandatory

EPOCH timestamp of the time at which request is being sent.
Example: 1588402269

version
string(4)
mandatory

Version of the API.

Example: v1

tokenType
string
mandatory

This is for authentication method.
For SSO token authentication, the value is SSO.
For checksum authentication, the value is CHECKSUM.

token
string
mandatory

For tokenType SSO, use SSO Token of Paytm User.
For tokenType CHECKSUM, It's value to be sent should be the checksum string created by using Paytm checksum library.
Note: Create the checksum using the body parameter of the request.

Body

AttributeDescription
mid
string(20)
mandatory

Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.

Example: INTEGR7769XXXXXX9383

items
object
mandatory

Item list sent for EMI

For Item based only

Items
+
AttributeDescription
id
string
mandatory

Any unique identifier for one item in the request e.g. in case of 2 items in the cart, the values can be sent as 1234 and 1236.

productId
string
mandatory

Unique product identifier for the merchant.

brandId
string
optional

Product brand identifier for the merchant e.g. LG, Sony etc. Should be send in the request if EMI plans are configured with brand attribute.

categoryList
string
mandatory

Product category identifiers for the merchant (categories can be Electronics, footwears etc). This should be sent in the request with same value which is configured in the EMI plan.

model
string
optional

Model id of the product. This should be sent if the merchant's EMI plans are configured with model attribute.

ean
string
optional

(Bar code Number) of product. This should be sent if the merchant's EMI plans are configured with EAN attribute.

price
double
mandatory

Cumulative price of the product (multiplied by quantity)

quantity
int
mandatory

Quantity of the product.

verticalId
string
mandatory

Merchant need to send this field with value "PAYTM_EMI"

isEmiEnabled
boolean
mandatory

Whether EMI is Enabled for the product.

filters
object
mandatory

Filters by type of card to fetch the tenure.

Filter
+
AttributeDescription
bankCode
string
mandatory

Code of corresponding bank(ICICI,SBI..)

cardType
boolean
mandatory

Type of card (CREDIT_CARD or DEBIT_CARD)

subventionAmount
string
optional

Amount on which merchant wants to offer subvention/Amount eligible for subvention

For Amount based only

Example: 4000.00

price
string
optional

Total amount of the cart without any subvention being applied

For Amount based only

Example: 7000.00

Response Attributes

Content Type : JSON

Head

AttributeDescription
requestId
string

Unique reference ID for a transaction which is generated by merchant and sent in the request

responseTimestamp
string(15)

EPOCH timestamp of the time at which response is being sent.
Example: 1588402269

version
string(2)

Version of the API passed in the request.
Example: v1

Body

AttributeDescription
resultInfo
object

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

ResultInfo
+
AttributeDescription
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
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 in section " Response Codes and Messages".

bankName
string

Name of the bank to which card belongs.

bankCode
string

Bank code of the card (ICICI,SBI...)

cardType
string

Type of Card(CREDIT_CARD or DEBIT_CARD)

planDetails
object

Details of the plan that are provided by the cardType

PlanDetails
+
AttributeDescription
planId
string

ID of plan

pgPlanId
string

Identified for the EMI plan. Its value will be in the form BANK_CODE

emiType
enum

Type of EMI. It's value can be SUBVENTION or STANDARD.

emiLabel
string

Label for EMI [Subvention, "Zero/Low Cost EMI", Standard EMI]

rate
double

Rate of interest in percentage for this EMI charged by bank.

interval
int

Interval of EMI in months e.g. 3, 6, 9, 12 etc.

emi
double

Effective EMI cost per month.

interest
double

Interest amount for this EMI charged by bank.

effectivePrice
double

Effective price of items.

gratifications
object

Gratitifications available on the plans. This field will be present for only subvention EMI plans.

Gratifications
+
AttributeDescription
value
double

Amount of gratficication e.g. the interest amount which is to be given as discount or cashback.

type
enum

Type of grattification, its value can be DISCOUNT or CASHBACK

label
string

Label for gratification.

itemBreakUp
object

Item wise distribution.

ItemBreakUp
+
AttributeDescription
id
string

ID of the item

interest
double

Interest aplicable on item

offerId
string

ID of the offer

emi
double

Type of Subvention

subventionType
enum

Type of Subvention

gratifications
object

Gratifications available on per item

Gratifications
+
AttributeDescription
value
double

Amount of gratficication e.g. the interest amount which is to be given as discount or cashback.

type
enum

Type of grattification, its value can be DISCOUNT or CASHBACK

label
string

Label for gratification.

finalTransactionAmount
string

Total amount on which transaction has to be done.

bankLogoUrl
string

URL for bank logo

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
0001FFAILED
1001FRequest parameters are not valid
1007FMissing mandatory element
2006FMID is invalid
EMI_001FMandatory info is missing
EMI_002FItems's data is not valid
EMI_003FItems are empty
EMI_004FSome error occured. Please try later
EMI_005FPlans not available right now. Please try later
EMI_006FNo emi options are available for these items
EMI_007FInvalid bank details
EMI_008FYou are not eligible for availing EMI on this card
EMI_009FSelected plan does not exist
EMI_010FSelected plan is not eligible for these items
EMI_011FSelected plan details might have changed
EMI_012FLock is acquired, please try after some time
EMI_013FCards details are invalid
EMI_014FNo subvented items found to be stamped
EMI_015FOrder data could not be stamped. Please try again
EMI_016FOrder item status could not be updated. Please try again
EMI_017FMore than 2 retries are not allowed
EMI_018FEMI is not enabled on some items.
EMI_019FSome of the selected offers are invalid
EMI_020FSelected plan is not offered by this bank
Staging
Production
https://securegw-stage.paytm.in/theia/api/v1/emiSubvention/tenures?mid={mid}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://securegw-stage.paytm.in/theia/api/v1/emiSubvention/tenures?mid={mid}' \
--header 'Content-Type: application/json' \
--data '{"body":{"items":[{"id":"ITEMID_98765","productId":"PRODUCTID_98765","brandId":"BRANDID_98765","categoryList":["Electronics"],"quantity":"1","price":"1000","verticalId":"PAYTM_EMI","isEmiEnabled":true}],"mid":"{mid}","filters":{"bankCode":"ICICI","cardType":"CREDIT_CARD"}},"head":{"requestId":"REQUESTID_98765","token":"{checksum}","tokenType":"CHECKSUM"}}'
copy icon