Body
EMI Plans V2
EMI plans (V2) API will help a merchant in getting a consolidated list of the EMIs enabled on the merchant MIDs across gateways. The response would cover:
Card EMIs (Standard, No Cost & Low Cost)
Cardless EMIs (Standard, No Cost & Low Cost)
Merchants need to configure the banks and tenure at JusPay’s end for which they wish to provide NO/ LOW Cost EMI to their users. Also if the gateway don't have their own EMI Plans API, then the merchant need to provide the EMI Plans to JusPay. And accordingly, the API response would cover the scenarios.
The response of the API can be directly consumed by the merchant to show the monthly EMI amount and the interest levied to the end customers on the merchant checkout page. The merchant need not do any calculation even in case of Low/ No Cost EMI.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/v2/emi/plans
Production Link
POST
https://api.juspay.in/v2/emi/plans
Headers
Content-Type
*
String
Mandatory
application/x-www-form-urlencoded
x-routing-id
*
String
Required
We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.
Warning
This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.
Example:- customer_1122
Parameters
order_amount
integer
Total order amount. Conditional (either order_id or amount are required)
order_id
string
JusPay Order ID. Conditional (either order_id or amount are required)
merchant_id
*
string
Mandatory
The username of the account you hold at Juspay
customer_id
string
Conditional
JusPay Customer identifier
Note: To retrieve the stored card EMI plans, passing the customer_id parameter is mandatory
mobile_number
integer
Customer Mobile number for eligibility check
order_basket
Array of objects
Order Basket Details
object
jSON
id
*
String
Mandatory
The unique id of the item that is intended for the offer/EMI
description
String
The description of the product
quantity
*
double
Mandatory
The number of items against a particular product
unitPrice
*
double
Mandatory
The price of the individual product
category
String
The category of the product. Eg: Electronics
sku
String
The unique identifier for a product.
productURL
String
The url which contains the image of the product
sellerType
String
The type of the seller, may be Vendor, MarketPlace
customParams
JSON
If there are any additional params to be passed merchants can make use of customParams. It should be key value pair.
gateway_reference_id
String
Pass gateway reference ID, if you need to filter plans accordingly
get_saved_card_emi_options
Boolean
Optional
This needs to be passed along with customer_id to get EMI plans on saved cards.
200 : Success
Response Body
cart_amount
string
Total order amount
emi_plans
object
List all the EMI Plans supported by underlying PGs
STANDARD_EMI
*
object
Mandatory
credit object
object
payment_method
String
CARD
payment_method_type
String
CARD
issuers
Array of objects
List of Issuers providing EMI Plans to customer
emi_bank
String
EMI Bank Identifier
issuer_name
String
Name of Issuing Bank
juspay_bank_code
String
JusPay Bank Code
bank_plan_description
String
tenures
Array of objects
List of Tenures supported by the issuing bank
offer_type
String
additional_processing_fee
String
Additional Processing Fee levied by certain issuers for EMI transactions
bank_interest_rate
String
Interest Rate for specific tenure, annualized
tenure
String
Tenure in months
total_amount_payable
String
Total amount payable by customer inclusive of
interest amount
total_interest_amount
String
Total interest amount payable by customer
total_monthly_amount_payable
String
Total monthly EMI amount payable by customer
total_instant_discount_amount
String
Total instant discount amount [EMI discount + any additional upfront discounts]
total_cashback_amount
String
Total cashback amount, if applicable
interest_discount_amount
String
Total interest discount amount, if applicable [No cost / Low cost]
supported_gateways
Array of objects
List of gateways supporting the EMI Plans
gateway
String
Gateway Name
gateway_id
Number
Juspay Gateway Identifier
additional_discount_amount
String
Total additional discount amount, if applicable [Bank offers etc.]
offer_ids
Array of String
List of offer Ids attached to the plan, applicable when Juspay offer engine is being used
product_details
Array of Objects
List of all products supported for the plan and includes detailed split-up
product_id
String
Product Identifier
product_amount
String
Total Product Amount
bank_interest_amount
String
Total interest amount payable by customer
emi_instant_discount_amount
String
Product wise additional Instant Discount, if applicable
emi_cashback_amount
String
Product wise cashback amount, if applicable
additional_cashback_info
String
Text field mentioning any additional cashback details, (Applicable for specific gateways)
interest_discount_amount
*
String
Mandatory
Product wise interest discount amount, if applicable [No cost / Low cost]
txn_emi_type
*
String
Mandatory
emi_type to be passed in txns request. This value can vary from the root block if merchant is using Juspay offer engine for running EMI offers [STANDARD_EMI, NO_COST_EMI, LOW_COST_EMI]
debit object
String
payment_method
String
CARD
payment_method_type
String
CARD
issuers
Array of objects
List of Issuers providing EMI Plans to customer
emi_bank
String
EMI Bank Identifier
issuer_name
String
Name of Issuing Bank
juspay_bank_code
String
JusPay Bank Code
bank_plan_description
String
tenures
Array of objects
List of Tenures supported by the issuing bank
offer_type
String
additional_processing_fee
String
Additional Processing Fee levied by certain issuers for EMI transactions
bank_interest_rate
String
Interest Rate for specific tenure
tenure
Integer
Tenure in months
total_amount_payable
String
Total amount payable by customer inclusive of
interest amount
total_interest_amount
String
Total interest amount payable by customer
total_monthly_amount_payable
String
Total monthly EMI amount payable by customer
total_instant_discount_amount
String
Total instant discount amount [EMI discount + any additional upfront discounts]
total_cashback_amount
String
Total cashback Amount, if applicable
additional_discount_amount
String
Total additional discount amount, if applicable [Bank offers etc.]
interest_discount_amount
String
Total interest discount amount, if applicable [No cost / Low cost]
supported_gateways
Array of Objects
List of gateways supporting the EMI Plans
offer_ids
Array of Strings
List of offer Ids attached to the plan, applicable when Juspay offer engine is being used
product_details
Array of objects
product_id
String
Product Identifier
product_amount
String
Total Product Amount
bank_interest_amount
String
Total interest amount payable by customer
emi_instant_discount_amount
String
Product wise additional Instant Discount, if applicable
emi_cashback_amount
String
Product wise cashback amount, if applicable
additional_cashback_info
String
Text field mentioning any additional cashback details, (For specific gateways)
interest_discount_amount
String
Product wise interest discount amount, if applicable [No cost / Low cost]
txn_emi_type
*
String
Mandatory
emi_type to be passed in txns request. This value can vary from the root block if merchant is using Juspay offer engine for running EMI offers [STANDARD_EMI, NO_COST_EMI, LOW_COST_EMI]
cardless
String
payment_method
String
FLEXMONEY/ ZESTMONEY/ SHOPSE. Note: Ignore this field and pick emi_bank field for passing payment_method in txns request for Cardless providers
payment_method_type
String
CONSUMER_FINANCE
issuers
Array of objects
List of Issuers providing EMI Plans to customer
emi_bank
String
EMI Bank Identifier
issuer_name
String
Name of Issuing Bank
juspay_bank_code
String
JusPay Bank Code
tenures
Array of objects
List of Tenures supported by the issuing bank
additional_processing_fee
String
Additional Processing Fee levied by certain issuers for EMI transactions
bank_interest_rate
String
Annualized interest rate
tenure
String
Tenure in months
total_amount_payable
String
Total amount payable by customer inclusive of interest amount
total_interest_amount
String
Total interest amount payable by customer
total_monthly_amount_payable
String
Total monthly EMI amount payable by customer
total_instant_discount_amount
String
Total instant discount amount [EMI discount + any additional upfront discounts]
total_cashback_amount
String
Total cashback Amount, if applicable
interest_discount_amount
String
Total interest discount amount, if applicable [No cost / Low cost]
additional_discount_amount
String
Total additional discount amount, if applicable [Bank offers etc.]
supported_gateways
Array of Objects
List of gateways supporting the EMI Plans
gateway
String
Gateway Name
gateway_id
Number
Juspay Gateway Identifier
offer_ids
Array of strings
List of offer Ids attached to the plan, applicable when Juspay offer engine is being used
product_details
Array of Objects
List of all products supported for the plan and includes detailed split-up
product_id
String
Product Identifier
product_amount
String
Total Product Amount
bank_interest_amount
String
Total interest amount payable by customer
emi_instant_discount_amount
String
Product wise additional Instant Discount, if applicable
emi_cashback_amount
String
Product wise cashback amount, if applicable
additional_cashback_info
String
Text field mentioning any additional cashback details, (For specific gateways)
interest_discount_amount
String
Product wise interest discount amount, if applicable [No cost / Low cost]
txn_emi_type
*
String
Mandatory
emi_type to be passed in txns request. This value can vary from the root block if merchant is using Juspay offer engine for running EMI offers [STANDARD_EMI, NO_COST_EMI, LOW_COST_EMI]
LOW_COST_EMI
*
object
Mandatory
credit object
object
payment_method
String
CARD
payment_method_type
String
CARD
issuers
Array of objects
List of Issuers providing EMI Plans to customer
emi_bank
String
EMI Bank Identifier
issuer_name
String
Name of Issuing Bank
juspay_bank_code
String
JusPay Bank Code
bank_plan_description
String
tenures
Array of objects
List of Tenures supported by the issuing bank
offer_type
String
additional_processing_fee
String
Additional Processing Fee levied by certain issuers for EMI transactions
bank_interest_rate
String
Interest Rate for specific tenure, annualized
tenure
String
Tenure in months
total_amount_payable
String
Total amount payable by customer inclusive of
interest amount
total_interest_amount
String
Total interest amount payable by customer
total_monthly_amount_payable
String
Total monthly EMI amount payable by customer
total_instant_discount_amount
String
Total instant discount amount [EMI discount + any additional upfront discounts]
total_cashback_amount
String
Total cashback amount, if applicable
interest_discount_amount
String
Total interest discount amount, if applicable [No cost / Low cost]
supported_gateways
Array of objects
List of gateways supporting the EMI Plans
gateway
String
Gateway Name
gateway_id
Number
Juspay Gateway Identifier
additional_discount_amount
String
Total additional discount amount, if applicable [Bank offers etc.]
offer_ids
Array of String
List of offer Ids attached to the plan, applicable when Juspay offer engine is being used
product_details
Array of Objects
List of all products supported for the plan and includes detailed split-up
product_id
String
Product Identifier
product_amount
String
Total Product Amount
bank_interest_amount
String
Total interest amount payable by customer
emi_instant_discount_amount
String
Product wise additional Instant Discount, if applicable
emi_cashback_amount
String
Product wise cashback amount, if applicable
additional_cashback_info
String
Text field mentioning any additional cashback details, (Applicable for specific gateways)
interest_discount_amount
*
String
Mandatory
Product wise interest discount amount, if applicable [No cost / Low cost]
txn_emi_type
*
String
Mandatory
emi_type to be passed in txns request. This value can vary from the root block if merchant is using Juspay offer engine for running EMI offers [STANDARD_EMI, NO_COST_EMI, LOW_COST_EMI]
debit object
String
payment_method
String
CARD
payment_method_type
String
CARD
issuers
Array of objects
List of Issuers providing EMI Plans to customer
emi_bank
String
EMI Bank Identifier
issuer_name
String
Name of Issuing Bank
juspay_bank_code
String
JusPay Bank Code
bank_plan_description
String
tenures
Array of objects
List of Tenures supported by the issuing bank
offer_type
String
additional_processing_fee
String
Additional Processing Fee levied by certain issuers for EMI transactions
bank_interest_rate
String
Interest Rate for specific tenure
tenure
Integer
Tenure in months
total_amount_payable
String
Total amount payable by customer inclusive of
interest amount
total_interest_amount
String
Total interest amount payable by customer
total_monthly_amount_payable
String
Total monthly EMI amount payable by customer
total_instant_discount_amount
String
Total instant discount amount [EMI discount + any additional upfront discounts]
total_cashback_amount
String
Total cashback Amount, if applicable
additional_discount_amount
String
Total additional discount amount, if applicable [Bank offers etc.]
interest_discount_amount
String
Total interest discount amount, if applicable [No cost / Low cost]
supported_gateways
Array of Objects
List of gateways supporting the EMI Plans
offer_ids
Array of Strings
List of offer Ids attached to the plan, applicable when Juspay offer engine is being used
product_details
Array of objects
product_id
String
Product Identifier
product_amount
String
Total Product Amount
bank_interest_amount
String
Total interest amount payable by customer
emi_instant_discount_amount
String
Product wise additional Instant Discount, if applicable
emi_cashback_amount
String
Product wise cashback amount, if applicable
additional_cashback_info
String
Text field mentioning any additional cashback details, (For specific gateways)
interest_discount_amount
String
Product wise interest discount amount, if applicable [No cost / Low cost]
txn_emi_type
*
String
Mandatory
emi_type to be passed in txns request. This value can vary from the root block if merchant is using Juspay offer engine for running EMI offers [STANDARD_EMI, NO_COST_EMI, LOW_COST_EMI]
cardless
String
payment_method
String
FLEXMONEY/ ZESTMONEY/ SHOPSE. Note: Ignore this field and pick emi_bank field for passing payment_method in txns request for Cardless providers
payment_method_type
String
CONSUMER_FINANCE
issuers
Array of objects
List of Issuers providing EMI Plans to customer
emi_bank
String
EMI Bank Identifier
issuer_name
String
Name of Issuing Bank
juspay_bank_code
String
JusPay Bank Code
tenures
Array of objects
List of Tenures supported by the issuing bank
additional_processing_fee
String
Additional Processing Fee levied by certain issuers for EMI transactions
bank_interest_rate
String
Annualized interest rate
tenure
String
Tenure in months
total_amount_payable
String
Total amount payable by customer inclusive of interest amount
total_interest_amount
String
Total interest amount payable by customer
total_monthly_amount_payable
String
Total monthly EMI amount payable by customer
total_instant_discount_amount
String
Total instant discount amount [EMI discount + any additional upfront discounts]
total_cashback_amount
String
Total cashback Amount, if applicable
interest_discount_amount
String
Total interest discount amount, if applicable [No cost / Low cost]
additional_discount_amount
String
Total additional discount amount, if applicable [Bank offers etc.]
supported_gateways
Array of Objects
List of gateways supporting the EMI Plans
gateway
String
Gateway Name
gateway_id
Number
Juspay Gateway Identifier
offer_ids
Array of strings
List of offer Ids attached to the plan, applicable when Juspay offer engine is being used
product_details
Array of Objects
List of all products supported for the plan and includes detailed split-up
product_id
String
Product Identifier
product_amount
String
Total Product Amount
bank_interest_amount
String
Total interest amount payable by customer
emi_instant_discount_amount
String
Product wise additional Instant Discount, if applicable
emi_cashback_amount
String
Product wise cashback amount, if applicable
additional_cashback_info
String
Text field mentioning any additional cashback details, (For specific gateways)
interest_discount_amount
String
Product wise interest discount amount, if applicable [No cost / Low cost]
txn_emi_type
*
String
Mandatory
emi_type to be passed in txns request. This value can vary from the root block if merchant is using Juspay offer engine for running EMI offers [STANDARD_EMI, NO_COST_EMI, LOW_COST_EMI]
NO_COST_EMI
*
object
Mandatory
credit object
object
payment_method
String
CARD
payment_method_type
String
CARD
issuers
Array of objects
List of Issuers providing EMI Plans to customer
emi_bank
String
EMI Bank Identifier
issuer_name
String
Name of Issuing Bank
juspay_bank_code
String
JusPay Bank Code
bank_plan_description
String
tenures
Array of objects
List of Tenures supported by the issuing bank
offer_type
String
additional_processing_fee
String
Additional Processing Fee levied by certain issuers for EMI transactions
bank_interest_rate
String
Interest Rate for specific tenure, annualized
tenure
String
Tenure in months
total_amount_payable
String
Total amount payable by customer inclusive of
interest amount
total_interest_amount
String
Total interest amount payable by customer
total_monthly_amount_payable
String
Total monthly EMI amount payable by customer
total_instant_discount_amount
String
Total instant discount amount [EMI discount + any additional upfront discounts]
total_cashback_amount
String
Total cashback amount, if applicable
interest_discount_amount
String
Total interest discount amount, if applicable [No cost / Low cost]
supported_gateways
Array of objects
List of gateways supporting the EMI Plans
gateway
String
Gateway Name
gateway_id
Number
Juspay Gateway Identifier
additional_discount_amount
String
Total additional discount amount, if applicable [Bank offers etc.]
offer_ids
Array of String
List of offer Ids attached to the plan, applicable when Juspay offer engine is being used
product_details
Array of Objects
List of all products supported for the plan and includes detailed split-up
product_id
String
Product Identifier
product_amount
String
Total Product Amount
bank_interest_amount
String
Total interest amount payable by customer
emi_instant_discount_amount
String
Product wise additional Instant Discount, if applicable
emi_cashback_amount
String
Product wise cashback amount, if applicable
additional_cashback_info
String
Text field mentioning any additional cashback details, (Applicable for specific gateways)
interest_discount_amount
*
String
Mandatory
Product wise interest discount amount, if applicable [No cost / Low cost]
txn_emi_type
*
String
Mandatory
emi_type to be passed in txns request. This value can vary from the root block if merchant is using Juspay offer engine for running EMI offers [STANDARD_EMI, NO_COST_EMI, LOW_COST_EMI]
debit object
String
payment_method
String
CARD
payment_method_type
String
CARD
issuers
Array of objects
List of Issuers providing EMI Plans to customer
emi_bank
String
EMI Bank Identifier
issuer_name
String
Name of Issuing Bank
juspay_bank_code
String
JusPay Bank Code
bank_plan_description
String
tenures
Array of objects
List of Tenures supported by the issuing bank
offer_type
String
additional_processing_fee
String
Additional Processing Fee levied by certain issuers for EMI transactions
bank_interest_rate
String
Interest Rate for specific tenure
tenure
Integer
Tenure in months
total_amount_payable
String
Total amount payable by customer inclusive of
interest amount
total_interest_amount
String
Total interest amount payable by customer
total_monthly_amount_payable
String
Total monthly EMI amount payable by customer
total_instant_discount_amount
String
Total instant discount amount [EMI discount + any additional upfront discounts]
total_cashback_amount
String
Total cashback Amount, if applicable
additional_discount_amount
String
Total additional discount amount, if applicable [Bank offers etc.]
interest_discount_amount
String
Total interest discount amount, if applicable [No cost / Low cost]
supported_gateways
Array of Objects
List of gateways supporting the EMI Plans
offer_ids
Array of Strings
List of offer Ids attached to the plan, applicable when Juspay offer engine is being used
product_details
Array of objects
product_id
String
Product Identifier
product_amount
String
Total Product Amount
bank_interest_amount
String
Total interest amount payable by customer
emi_instant_discount_amount
String
Product wise additional Instant Discount, if applicable
emi_cashback_amount
String
Product wise cashback amount, if applicable
additional_cashback_info
String
Text field mentioning any additional cashback details, (For specific gateways)
interest_discount_amount
String
Product wise interest discount amount, if applicable [No cost / Low cost]
txn_emi_type
*
String
Mandatory
emi_type to be passed in txns request. This value can vary from the root block if merchant is using Juspay offer engine for running EMI offers [STANDARD_EMI, NO_COST_EMI, LOW_COST_EMI]
cardless
String
payment_method
String
FLEXMONEY/ ZESTMONEY/ SHOPSE. Note: Ignore this field and pick emi_bank field for passing payment_method in txns request for Cardless providers
payment_method_type
String
CONSUMER_FINANCE
issuers
Array of objects
List of Issuers providing EMI Plans to customer
emi_bank
String
EMI Bank Identifier
issuer_name
String
Name of Issuing Bank
juspay_bank_code
String
JusPay Bank Code
tenures
Array of objects
List of Tenures supported by the issuing bank
additional_processing_fee
String
Additional Processing Fee levied by certain issuers for EMI transactions
bank_interest_rate
String
Annualized interest rate
tenure
String
Tenure in months
total_amount_payable
String
Total amount payable by customer inclusive of interest amount
total_interest_amount
String
Total interest amount payable by customer
total_monthly_amount_payable
String
Total monthly EMI amount payable by customer
total_instant_discount_amount
String
Total instant discount amount [EMI discount + any additional upfront discounts]
total_cashback_amount
String
Total cashback Amount, if applicable
interest_discount_amount
String
Total interest discount amount, if applicable [No cost / Low cost]
additional_discount_amount
String
Total additional discount amount, if applicable [Bank offers etc.]
supported_gateways
Array of Objects
List of gateways supporting the EMI Plans
gateway
String
Gateway Name
gateway_id
Number
Juspay Gateway Identifier
offer_ids
Array of strings
List of offer Ids attached to the plan, applicable when Juspay offer engine is being used
product_details
Array of Objects
List of all products supported for the plan and includes detailed split-up
product_id
String
Product Identifier
product_amount
String
Total Product Amount
bank_interest_amount
String
Total interest amount payable by customer
emi_instant_discount_amount
String
Product wise additional Instant Discount, if applicable
emi_cashback_amount
String
Product wise cashback amount, if applicable
additional_cashback_info
String
Text field mentioning any additional cashback details, (For specific gateways)
interest_discount_amount
String
Product wise interest discount amount, if applicable [No cost / Low cost]
txn_emi_type
*
String
Mandatory
emi_type to be passed in txns request. This value can vary from the root block if merchant is using Juspay offer engine for running EMI offers [STANDARD_EMI, NO_COST_EMI, LOW_COST_EMI]
API Latency Guidelines
What is API Latency?
Time taken by the server to respond to the API request.
Average API Percentile Metrics and Recommended Timeout
TP50 (ms): This represents the median latency, meaning 50% of all requests are completed in this time or less. It indicates the typical performance experienced by the majority of users.
TP90 (ms): This value shows that 90% of requests are completed within this time, leaving 10% of requests that take longer. It gives insight into the performance for a broader set of users, beyond the median.
TP99 (ms): This value indicates that 99% of requests finish within this time, with only 1% of requests taking longer. It helps identify outlier cases where latency may become an issue for a small group of users.
TP99.9 (ms): This metric captures extreme latency outliers, where only 0.1% of requests take longer than this value. It’s useful for understanding edge cases where performance degrades for very few users.
TP99.99 (ms): This measures the most rare and severe performance outliers, where just 0.01% of requests exceed this time. Monitoring this helps in addressing the rarest and most critical latency issues that may impact user experience in exceptional scenarios.
Note
Please note that this API call has an external dependency, as it dynamically fetches EMI plans configured at the respective PG's end. Therefore, the response time of this API request is dependent on the underlying PG's response time.
Scroll inside to view more
|
Transaction Percentile
|
Latency (ms)
|
|---|---|
TP50 (ms)
| 114
|
TP90 (ms)
| 666.85
|
TP99 (ms)
| 2909.85
|
TP99.9 (ms)
| 7548.14
|
Recommended Timeout(ms)
| 8000
|
2 columns 6 rows
Warning
The recommended timeouts are based on TP99.9 data, though edge cases (0.01% of requests) may still exceed these limits and are captured in the TP99.99 data as shown below.
Scroll inside to view more
|
Transaction Percentile
|
Latency (ms)
|
|---|---|
TP99.99 (ms)
| 11424.28
|
Recommended Timeout(ms)
| 12000
|
2 columns 3 rows
Have questions?
- Need help? Contact support
- LLM? Read llms.txt