You can use this API to display the EMI plans along with all offers on the checkout page. This API may also be used to display the EMI plans on Product Page or any other screen the merchant may deem fit. You can use it for the following:
- Fetch EMI plans: You can use this API to fetch EMI Amounts, rate of interest, total amount to be paid across eligible banks.
- Fetch EMI plans for a particular bank
- Fetch EMI plan for a particular bank & tenure
- Fetch EMI plans with best offers applicable
- Fetch EMI plans with one offer applied
- Fetch EMI plans with SKU based offers
Environment
| Test Environment | https://apitest.payu.in/calculateEmi/v2 |
| Production Environment | https://api.payu.in/calculateEmi/v2 |
Header parameters
| Parameter | Example |
|---|---|
| accept | application/json |
| content-type | application/json |
| x-credential-username | OADt8R |
Request parameters
| Parameter | Description |
|---|---|
amountmandatory | This parameter must include the principal amount that needs to be converted into EMI. |
additional_chargesoptional | This parameter must include the convenience fee if the merchant wants to collect. |
offer_keyoptional | This parameter must contain the offer key for the transaction-level offer. |
autoApplyOfferoptional | This parameter must be set to true if the merchant wants to apply best offer when no transaction offer keys specified. |
skusoptional | This parameter must include the SKU data. |
| skus.skuAmount mandatory | This parameter must contain the amount per SKU. |
| skus.quantity mandatory | This parameter must contain the SKU quantity. |
| skus.skuName mandatory | This parameter must contain the name of SKU. |
skus.offerKeysoptional | This parameter must contain the offer key for SKU. |
| skus.autoApplyOffer | This parameter must be set to true if the merchant wants to apply best offer when no SKU offer keys specified.. |
bankCodesoptional | This parameter must contain the bank codes for filtering. |
emiCodesoptional | This parameter must contain the EMI bankcodes for filtering. |
disableOverrideNceConfigoptional | This parameter must be set to true PayU will not consider NCE through merchant parameters for the merchant. |
Sample request
curl --location --request POST 'https://apitest.payu.in/calculateEmi/v2' \
--header 'x-credential-username: smsplus' \
--header 'Content-Type: application/json' \
--data-raw '{
"txnAmount": 10000,
"additionalCharges": 0,
"offerKeys": null,
"autoApplyOffer": true,
"bankCodes":null,
"emiCodes":null,
"disableOverrideNceConfig": true,
"skus": [
{
"skuId": "Product1",
"skuAmount": 8000,
"quantity": 1,
"offerKeys": null,
"autoApplyOffer": false
},
{
"skuId": "Product2",
"skuAmount": 1000,
"quantity": 2,
"offerKeys": null,
"autoApplyOffer": false
}
]
}'
Sample response
{
"message": "Success",
"status": 1,
"result": {
"YES": {
"EMIY18": {
"transactionAmount": 10000.0,
"payBackAmount": 0.0,
"emiAmount": 555.56,
"additionalCost": "0.0",
"emiMdrNote": 0.0,
"emiBankInterest": 15.0,
"bankRate": 0.0,
"bankCharge": 0.0,
"amount": 555.56,
"cardType": "credit card",
"tenure": "18 months",
"loanAmount": 10000.0,
"offerKeys": null,
"offerDiscount": {
"total": 0.0,
"instant": 0.0,
"cashback": 0.0
},
"nceDiscount": {
"total": 1266.78,
"instant": 1266.78,
"cashback": 0.0
},
"sku": [
{
"skuId": "Product1",
"amountPerSku": 8000.0,
"amount": 8000.0,
"quantity": 1,
"offerKeys": null,
"emiAmount": 444.44,
"emiBankInterest": 15.0,
"emiValue": 444.44,
"emiInterestPaid": 1013.42,
"offerDiscount": {
"total": 0.0,
"instant": 0.0,
"cashback": 0.0
},
"nceDiscount": {
"total": 1013.42,
"instant": 1013.42,
"cashback": 0.0
},
"totalPayableAmount": 7999.92,
"nceDiscountAmount": 1013.42,
"subventionAmount": 8000.0,
"revisedPrincipal": 8000.0,
"additionalCharge": 0.0
},
{
"skuId": "Product2",
"amountPerSku": 1000.0,
"amount": 2000.0,
"quantity": 2,
"offerKeys": null,
"emiAmount": 111.11,
"emiBankInterest": 15.0,
"emiValue": 111.11,
"emiInterestPaid": 253.36,
"offerDiscount": {
"total": 0.0,
"instant": 0.0,
"cashback": 0.0
},
"nceDiscount": {
"total": 1266.78,
"instant": 1266.78,
"cashback": 0.0
},
"totalPayableAmount": 1999.98,
"nceDiscountAmount": 253.36,
"subventionAmount": 2000.0,
"revisedPrincipal": 2000.0,
"additionalCharge": 0.0
}
],
"totalPayableAmount": 10000.0,
"nceDiscountAmount": 1266.78,
"revisedPrincipal": 10000.0,
"subventionAmount": 10000.0,
"gstSubvention": true,
"nceViaConfig": true,
"bankCode": "YESB",
"emi_value": 555.55,
"emi_interest_paid": 1266.78
},