POSTBanks API - EMI Subvention

Use Case

Purpose of this API is to provide the list of banks, grouped by EMI-type (standard/subvention) available for EMI.

Request Attributes

Content Type : JSON

Head

Attribute	Description
channelId string(3) optional	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

Attribute

Description

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

Attribute	Description
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 mandatory	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)
originalPrice string conditional	The original price/value of the cart before discount is applied.
quantity int mandatory	Quantity of the product.

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

Attribute	Description
requestId string(32)	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

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 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".

emiTypes

object

List of banks grouped by Emi Types. Any bank providing both subvention and standard EMI plans will be shown in subvention group.

EmiTypes

Attribute

Description

type

enum

Type of EMI (Subvention or Standard)

label

string

Label of EMI. This response field explains whether EMI type provided by bank is Zero/Low cost or Standard EMI.

info

string

Info about EMI.

cardTypes

object

Information about the type of card on which EMI is enabled on list of Items

CardTypes

Attribute

Description

cardLabel

string

Label assigned to the card.

cardType

string

Type of Card(CREDIT_CARD or DEBIT_CARD)

bankDetails

object

Bank details including bank name and bank logo.

BankDetails

Attribute	Description
bankName string	Name of the bank to which card belongs.
bankCode string	Bank code of the card (ICICI,SBI...)
bankLogoUrl string	URL of the bank logo

Response Codes & Messages

resultCode	resultStatus	resultMsg
0000	S	Success
0001	F	FAILED
1001	F	Request parameters are not valid
1007	F	Missing mandatory element
2006	F	MID is invalid
EMI_001	F	Mandatory info is missing
EMI_002	F	Items's data is not valid
EMI_003	F	Items are empty
EMI_004	F	Some error occured. Please try later
EMI_005	F	Plans not available right now. Please try later
EMI_006	F	No emi options are available for these items
EMI_007	F	Invalid bank details
EMI_008	F	You are not eligible for availing EMI on this card
EMI_009	F	Selected plan does not exist
EMI_010	F	Selected plan is not eligible for these items
EMI_011	F	Selected plan details might have changed
EMI_012	F	Lock is acquired, please try after some time
EMI_013	F	Cards details are invalid
EMI_014	F	No subvented items found to be stamped
EMI_015	F	Order data could not be stamped. Please try again
EMI_016	F	Order item status could not be updated. Please try again
EMI_017	F	More than 2 retries are not allowed
EMI_018	F	EMI is not enabled on some items
EMI_019	F	Some of the selected offers are invalid
EMI_020	F	Selected plan is not offered by this bank

⇾

Staging

Production

https://securestage.paytmpayments.com/theia/api/v1/emiSubvention/banks?mid={mid} copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securestage.paytmpayments.com/theia/api/v1/emiSubvention/banks?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}"},"head":{"requestId":"REQUESTID_98765","token":"{CHECKSUM}","tokenType":"CHECKSUM"}}'