get https://api.juspay.in/v2/emi/plans
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)
- Debit 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 doesn't have their its own EMI Plans API, then the merchant would 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.
Response Parameter Details
(click to open tables)
(click to open tables)
| Field | Type | Description |
|---|---|---|
| cart_amount | String | Total order amount |
| emi_plans | Object | Lists all the EMI Plans supported by underlying PGs (Object consists of three emi_type objects) |
Parameters for
emi_plan object: | emi_type | 3 Objects | STANDARD_EMI/ LOW_COST_EMI/ NO_COST_EMI (Each object consists of three card_type objects) |
Parameters for each
emi_type object: | card_type | 3 Objects | CREDIT/ DEBIT/ CARDLESS (Each object consist of parameters below:) |
Parameters for each
card_type object: | payment_method | String | CARD/ FLEXMONEY/ ZESTMONEY/ SHOPSE |
| payment_method_type | String | CARD/ CONSUMER_FINANCE |
| issuers: [{...}.{...},...] | Array of Objects | List of Issuers providing EMI Plans to customer |
Parameters for each issuer object in array: (click to view)
| Field | Type | Description |
|---|---|---|
| emi_bank | String | EMI Bank Identifier |
| issuer_name | String | Name of Issuing Bank |
| juspay_bank_code | String | JusPay Bank Code |
| bank_plan_description | String | Optional details of bank plan |
| tenures: [{...}.{...},..] | Array of Objects | List of Tenures supported by the issuing bank |
Parameters for each tenure object in array: (click to view)
| Field | Type | Description |
|---|---|---|
| offer_type | String | examples are: INSTANT_DISCOUNT, BUYBACK |
| additional_processing_fee | String | Additional Processing Fee levied by certain issuers for EMI transactions |
| bank_interest_rate | String | Interest Rate for specific tenure |
| 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 | Cashback Amount, if applicable |
| total_instant_discount_amount | String | Instant Discount, if applicable |
| total_cashback_amount | String | Cashback Amount, if applicable |
| additional_discount_amount | String | Addtional Discount, if applicable |
| product_details: [{...}.{...},...] | Array of Objects | List of all products supported for the particular combination |
Parameters for each product_details object in array: (click to view)
| Field | Type | Description |
|---|---|---|
| productId | String | Product Identifier |
| productAmount | String | Total Product Amount |
| bankInterestAmount | String | Total interest amount payable by customer |
| emiInstantDiscountAmount | String | Instant Discount, if applicable |
| emiCashbackAmount | String | Cashback Amount, if applicable |
| supported_gateways:[{...}.{...},...] | Array of Objects | List of gateways supporting the EMI Plans |
Parameters for each supported_gateways object in array: (click to view)
| Field | Type | Description |
|---|---|---|
| gateway | String | Gateway Name |
| gateway_id | Integer | JusPay Gateway Identifier |
| metadata: {...} | Object | Metadata parameters |
Parameters for metadata object: (click to view)
| Field | Type | Example |
|---|---|---|
| emiPlanId | String | ww"ID_24_13"ww |
| offerDetails: [{...}.{...},...] | Array of Objects | See table below |
Parameters for each offer_details object in array: (click to view)
| Field | Type | Example |
|---|---|---|
| offerId | String | "byuback_12931"w |
| offerType | String | "buyback", |
| offerDiscountAmount | String | "1795" |
| title | String | "Apple Forever" |
| offerTNC | String | "https://url-2-offer" |
| remark | String | "Terms&Conditions" |
| stepUpInterestRate | String | wwww "10"wwww |
| stepUpEMI | String | "3333.33" |
| stepUpTenure | String | "12" |
| buybackNoCostTenure | String | "12" |
The request consists of the following parameters:
⭣
Note that
order_basket is an array of objects in the format:'order_basket=[{....},{....},...]'Each object contains parameters that describe a product ordered.
(click to open table)
(click to open table)
| Field | Type | Description |
|---|---|---|
| id | String | Product ID |
| description | String | Description of Product |
| quantity | Double | Total Product Amount |
| unitPrice | Double | Cost of one Product |
| category | String | Type of Product |
| sku | String | SKU Number of Product |
| productURL | String | URL where Product can be found |
| sellerType | String | Type of Seller |
| "customParams": {"name1":"value1","name2":"value2"} | Object | Descriptive Attributes of Product |