POSTDC EMI Eligibility API

Use Case

This API can be used to check the eligibility of the customer for DC EMI using the registered mobile number with the Debit card bank account.

Request Attributes

Content Type : JSON

Head

Attribute	Description
version string optional	Version of the API. Example: v1
channelId string optional	The parameter value identifies the Channel for which the API call is initiated. Possible Values: APP, WEB, WAP, SYSTEM
requestTimestamp string mandatory	EPOCH timestamp of the time at which request is being sent. Example: 1588402269
tokenType string mandatory	This is for authentication method. For checksum authentication, the value is CHECKSUM. Possible Values: TXN_TOKEN/ACCESS/CHECKSUM
token string mandatory	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

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

emiTypes

Array of Strings

mandatory

Types of emi for which the eligibility has to be checked
Possible Values: DEBIT_CARD

Example: [DEBIT_CARD]

channelCode

string

optional

The bank code for which the user eligibility for Debit Card EMI has to be determined.
Note: If the eligibility has to be determined for all the banks configured on the merchant, do not send the bank code

Example: "ICICI"

userInfo

object

mandatory

User's mobile number used to determine the user's eligibility for Debit card EMI

userInfo

Attribute	Description
mobileNumber string mandatory	10-digit registered mobile number of the user. Example: 9988000000

txnAmount

string

optional

The amount for which DebitCard EMI eligibility is to be retrieved

Response Attributes

Content Type : JSON

Head

Attribute	Description
responseTimestamp string	EPOCH timestamp of the time at which response is being sent. Example: 1588402269
version string	Version of the API passed in the request. Example: v1
clientId string	Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.
signature string	You should validate the parameter values by verifying the signature comes in the response. It ensures that parameter values not tempered. Signature string can be verified by using Paytm checksum library.

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.
resultCodeId string	Result code id returned to merchant.
resultStatus string	This parameter indicates the status of API call. Possible Values: S For Success , F For Failure
resultMsg string (256)	This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below.

emiEligibility

Array of objects

Returns the plans available which are available for Debit Card EMI on the basis of the eligibility determined using the phone number and channelCode

emiEligibility

Attribute

Description

emiType

string

Type of EMI.
Possible values: DEBIT_CARD

channelCode

string

The bank for which we need to check if the user is eligible for Debit card EMI

Example: "ICICI"

eligible

string

Specifies if the user is eligible for the specific bank's Debit Card EMI

Possible Values: "true", "false"

message

string

The message that can be shown in the case when user is not eligible for Debit Card EMI of specific bank

Example: "User not eligible for KOTAK Debit card EMI"

emiDetails

Array of Objects

List of emiPlans configured on the merchant

emiDetails

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

Response Codes & Messages

resultCode	resultStatus	resultMsg
0000	S	Success
3004	F	EMI not configured on merchant
9999	F	Something went wrong
3001	F	Internal Processing Error
3001	F	Unable to determine eligibility for HDFC at this time

⇾

Staging

Production

https://securegw-stage.paytm.in/theia/api/v1/checkEMIEligibility copy icon

REQUEST

RESPONSE

CURL

JAVA

PHP

NODE

PYTHON

DOTNET

curl --location 'https://securegw-stage.paytm.in/theia/api/v1/checkEMIEligibility' \
--header 'Content-Type: application/json' \
--data '{"head":{"version":"v1","requestTimestamp":"{{timestamp}}","channelId":"WEB","tokenType":"ACCESS","token":"{{accessToken}}"},"body":{"userInfo":{"mobileNumber":"9999999999"},"mid":"{{YOUR-MID-HERE}}","channelCode":"HDFC","emiTypes":["DEBIT_CARD"]}}'