Overview of the Offer Discovery API response object.
Shown below is a sample response returned through our Offer Discovery API.
{
"issuers": [
{
"id": "23",
"name": "INDUSIND CC",
"display_name": "INDUSIND",
"issuer_type": "CC_BANK",
"priority": 1,
"tenures": [
{
"tenure_id": "1",
"name": "3 Months",
"tenure_type": "MONTH",
"tenure_value": 3,
"issuer_offer_parameters": [
{
"program_type": "BANK_EMI",
"offer_id": "1563",
"offer_parameter_id": "63813"
}
],
"details": [],
"loan_amount": {
"currency": "INR",
"value": 1200000
},
"net_payment_amount": {
"currency": "INR",
"value": 1232139
},
"monthly_emi_amount": {
"currency": "INR",
"value": 410713
},
"total_emi_amount": {
"currency": "INR",
"value": 1232139
},
"interest_amount": {
"currency": "INR",
"value": 32139
},
"interest_rate_percentage": 16,
"processing_fee_details": {
"amount": {
"currency": "INR",
"value": 19900
}
},
"emi_type": "STANDARD"
},
{
"tenure_id": "2",
"name": "6 Months",
"tenure_type": "MONTH",
"tenure_value": 6,
"issuer_offer_parameters": [
{
"program_type": "BANK_EMI",
"offer_id": "1563",
"offer_parameter_id": "63813"
}
],
"details": [],
"loan_amount": {
"currency": "INR",
"value": 1200000
},
"net_payment_amount": {
"currency": "INR",
"value": 1256616
},
"monthly_emi_amount": {
"currency": "INR",
"value": 209436
},
"total_emi_amount": {
"currency": "INR",
"value": 1256616
},
"interest_amount": {
"currency": "INR",
"value": 56616
},
"interest_rate_percentage": 16,
"processing_fee_details": {
"amount": {
"currency": "INR",
"value": 19900
}
},
"emi_type": "STANDARD"
},
{
"tenure_id": "3",
"name": "9 Months",
"tenure_type": "MONTH",
"tenure_value": 9,
"issuer_offer_parameters": [
{
"program_type": "BANK_EMI",
"offer_id": "1563",
"offer_parameter_id": "63813"
}
],
"details": [],
"loan_amount": {
"currency": "INR",
"value": 1200000
},
"net_payment_amount": {
"currency": "INR",
"value": 1281411
},
"monthly_emi_amount": {
"currency": "INR",
"value": 142379
},
"total_emi_amount": {
"currency": "INR",
"value": 1281411
},
"interest_amount": {
"currency": "INR",
"value": 81411
},
"interest_rate_percentage": 16,
"processing_fee_details": {
"amount": {
"currency": "INR",
"value": 19900
}
},
"emi_type": "STANDARD"
},
{
"tenure_id": "4",
"name": "12 Months",
"tenure_type": "MONTH",
"tenure_value": 12,
"issuer_offer_parameters": [
{
"program_type": "BANK_EMI",
"offer_id": "1563",
"offer_parameter_id": "63813"
}
],
"details": [],
"loan_amount": {
"currency": "INR",
"value": 1200000
},
"net_payment_amount": {
"currency": "INR",
"value": 1306524
},
"monthly_emi_amount": {
"currency": "INR",
"value": 108877
},
"total_emi_amount": {
"currency": "INR",
"value": 1306524
},
"interest_amount": {
"currency": "INR",
"value": 106524
},
"interest_rate_percentage": 16,
"processing_fee_details": {
"amount": {
"currency": "INR",
"value": 19900
}
},
"emi_type": "STANDARD"
},
{
"tenure_id": "5",
"name": "18 Months",
"tenure_type": "MONTH",
"tenure_value": 18,
"issuer_offer_parameters": [
{
"program_type": "BANK_EMI",
"offer_id": "1563",
"offer_parameter_id": "63813"
}
],
"details": [],
"loan_amount": {
"currency": "INR",
"value": 1200000
},
"net_payment_amount": {
"currency": "INR",
"value": 1357686
},
"monthly_emi_amount": {
"currency": "INR",
"value": 75427
},
"total_emi_amount": {
"currency": "INR",
"value": 1357686
},
"interest_amount": {
"currency": "INR",
"value": 157686
},
"interest_rate_percentage": 16,
"processing_fee_details": {
"amount": {
"currency": "INR",
"value": 19900
}
},
"emi_type": "STANDARD"
},
{
"tenure_id": "6",
"name": "24 Months",
"tenure_type": "MONTH",
"tenure_value": 24,
"issuer_offer_parameters": [
{
"program_type": "BANK_EMI",
"offer_id": "1563",
"offer_parameter_id": "63813"
}
],
"details": [],
"loan_amount": {
"currency": "INR",
"value": 1200000
},
"net_payment_amount": {
"currency": "INR",
"value": 1410120
},
"monthly_emi_amount": {
"currency": "INR",
"value": 58755
},
"total_emi_amount": {
"currency": "INR",
"value": 1410120
},
"interest_amount": {
"currency": "INR",
"value": 210120
},
"interest_rate_percentage": 16,
"processing_fee_details": {
"amount": {
"currency": "INR",
"value": 19900
}
},
"emi_type": "STANDARD"
}
],
"issuer_data": {
"otp_length": 5,
"otp_time_in_sec": 180,
"otp_retry_count": 5,
"is_consent_page_required": true,
"consent_data": "<div classname=concent-container><div classname=concentTitle>Consent Clause :</div><div classname=concentSection><div classname=concentText>I/We hereby expressly authorize and give consent to ICICI Bank to, disclose, transfer or part with any of my/our information, (including location), or any other device information when ICICI Bank considers such disclosure as necessary, with:{' '}</div></div><div classname=concentSection><div classname=concentText>A. Agents of ICICI Bank, ICICI Bank's group entities/in any jurisdiction;</div><div classname=concentText>B. Auditors, credit rating agencies/credit bureaus, statutory/regulatory authorities, governmental/administrative authorities, Central Know Your Customer (CKYC) registry or SEBI Know Your Client registration agency, having jurisdiction over ICICI Bank or its group entities;{' '}</div><div classname=concentText>{' '} C. Service providers, or such person with whom ICICI Bank contracts or proposes to contract; (Collectively referred to as “Permitted Persons”){' '}</div></div><div classname=concentSection><div classname=concentText>For the purposes of:</div><div classname=concentText>1. Provision of the facility and completion of on-boarding formalities; or{' '}</div><div classname=concentText>2. Complying with KYC requirements; or{' '}</div><div classname=concentText>{' '} 3. Compliance with applicable laws or any order (judicial or otherwise), statutory/regulatory requirement; or{' '}</div><div classname=concentText>{' '} 4. For credit review of facilities availed; or{' '}</div><div classname=concentText>5. Authentication or verification; or{' '}</div><div classname=concentText>6. Research or analysis, credit reporting & scoring, risk management, participation in any telecommunication; or{' '}</div><div classname=concentText>7. Electronic clearing network and for use or processing of the said information/data.{' '}</div><div classname=concentText>{' '} 8. Disclosing any default in payment, for the purposes of recovering such amounts.{' '}</div></div><div classname=concentText>D. For detailed Privacy Policy of the ICICI bank, please visit{' '} <a classname=concent-doc-link href=https://www.icicibank.com/privacy.page rel=noreferrer target=_blank><u>https://www.icicibank.com/privacy.page</u></a></div></div>",
"terms_and_conditions": "Sample TNC",
"show_key_fact_statement": true,
"auth_type": "PENNY_DROP",
"penny_transaction_amount": {
"currency": "INR",
"value": 100
},
"is_tokenized_transaction_supported": false
}
}
]
}
{
"issuers": [
{
"id": "19",
"name": "KOTAK DC",
"display_name": "KOTAK BANK",
"issuer_type": "DC_BANK",
"priority": 1,
"tenures": [
{
"tenure_id": "7",
"name": "No EMI Only Cashback",
"tenure_type": "MONTH",
"tenure_value": 0,
"issuer_offer_parameters": [
{
"program_type": "BANK_EMI",
"offer_id": "308",
"offer_parameter_id": "19"
},
{
"program_type": "MERCHANT_BANK_OFFER",
"offer_id": "3491",
"offer_parameter_id": "199672"
}
],
"details": [
{
"product_code": "redmi_1",
"product_display_name": "Redmi Note 14 5G",
"brand_name": "Xiaomi",
"product_amount": {
"currency": "INR",
"value": 219900
},
"interest_rate": 0,
"discount": {
"discount_type": "DEFERRED",
"discount_string": "You are eligible for a cashback of 10.0% upto Rs. 200, will be posted within 90 days. T&C applied.",
"percentage": 10,
"amount": {
"currency": "INR",
"value": 200
},
"max_amount": {
"currency": "INR",
"value": 200
},
"discount_deferred_duration_value": 90,
"discount_deferred_duration_type": "DAY"
}
}
],
"discount": {
"discount_type": "DEFERRED",
"discount_string": "You are eligible for a cashback of 10.0% upto Rs. 200, will be posted within 90 days. T&C applied.",
"percentage": 10,
"amount": {
"currency": "INR",
"value": 200
},
"max_amount": {
"currency": "INR",
"value": 200
},
"discount_deferred_duration_value": 90,
"discount_deferred_duration_type": "DAY"
},
"loan_amount": {
"currency": "INR",
"value": 219900
},
"total_discount_amount": {
"currency": "INR",
"value": 200
},
"net_payment_amount": {
"currency": "INR",
"value": 219700
},
"monthly_emi_amount": {
"currency": "INR",
"value": 219900
},
"total_emi_amount": {
"currency": "INR",
"value": 219900
},
"interest_rate_percentage": 0,
"processing_fee_details": {
"percentage": 0,
"amount": {
"currency": "INR",
"value": 19900
}
},
"emi_type": "STANDARD"
},
{
"tenure_id": "5",
"name": "18 Months",
"tenure_type": "MONTH",
"tenure_value": 18,
"issuer_offer_parameters": [
{
"program_type": "BANK_EMI",
"offer_id": "308",
"offer_parameter_id": "19"
}
],
"details": [
{
"product_code": "redmi_1",
"product_display_name": "Redmi Note 14 5G",
"brand_name": "Xiaomi",
"product_amount": {
"currency": "INR",
"value": 219900
},
"interest_amount": {
"currency": "INR",
"value": 34548
},
"interest_rate": 19
}
],
"loan_amount": {
"currency": "INR",
"value": 219900
},
"net_payment_amount": {
"currency": "INR",
"value": 254448
},
"monthly_emi_amount": {
"currency": "INR",
"value": 14136
},
"total_emi_amount": {
"currency": "INR",
"value": 254448
},
"interest_amount": {
"currency": "INR",
"value": 34548
},
"interest_rate_percentage": 19,
"processing_fee_details": {
"percentage": 0,
"amount": {
"currency": "INR",
"value": 19900
}
},
"emi_type": "STANDARD"
}
],
"issuer_data": {
"otp_length": 6,
"otp_time_in_sec": 30,
"otp_retry_count": 3,
"is_consent_page_required": false,
"consent_data": "Sample Consent",
"terms_and_conditions": "Sample TNC",
"show_key_fact_statement": true,
"auth_type": "OTP",
"is_tokenized_transaction_supported": false
}
}
]
}
The table below lists the various parameters returned in the offer discovery response object.
Parameter | Type | Description |
---|---|---|
id | String | Unique identifier of the issuer id in the Plural database. Example: 23 |
name | String | Name of the Issuer. Example: INDUSIND CC |
display_name | string | Name of the issuer offering the offer. Example: INDUSIND |
issuer_type | String | The type of the Issuer offering the offer. Accepted values:
|
priority | integer | The priority of the issuer providing the offer. Example: 1 |
tenures | array of objects | An array of objects that contains the tenures details. Learn more about the tenures child object. |
issuer_data | objects | An object that contains the issuer data details. Learn more about the issuer_data child object. |
Tenures [Child Object]
The table below lists the various parameters in the tenures
object. This is part of the offer discovery response object.
Parameter | Type | Description |
---|---|---|
tenure_id | String | Tenure id in the Plural database. Example: 1 |
name | String | The name of the Issuer offering the offer.. Example: 3 Months |
tenure_type | String | The type of the Tenure. Accepted values:
|
tenure_value | integer | The value of the tenure. Example: 3 |
issuer_offer_parameters | array of objects | An array of objects that contains the issuer_offer_parameters details.Learn more about the issuer_offer_parameters child object. |
details | array of objects | An array of objects that contains the product details .Learn more about the details child object. |
discount | object | An object that contains the discount details. Learn more about the discount child object. |
loan_amount | object | An object that contains the loan amount details. Learn more about the loan_amount child object. |
total_discount_amount | object | An object that contains the total discount amount details. Learn more about the total_discount_amount child object. |
net_payment_amount | object | An object that contains the net payment amount details. Learn more about the net_payment_amount child object. |
monthly_emi_amount | object | An object that contains the monthly EMI amount details. Learn more about the monthly_emi_amount child object. |
total_emi_amount | object | An object that contains the total EMI amount details. Learn more about the total_emi_amount child object. |
interest_amount | object | An object that contains the interest amount details. Learn more about the interest_amount child object. |
total_subvention_amount | object | An object that contains the total subvention amount details. Learn more about the total_subvention_amount child object. |
interest_rate_percentage | float | Interest rate percentage for the tenure. Example: 16.90 |
processing_fee_details | object | An object that contains the processing fee details. Learn more about the processing_fee_details child object. |
convenience_fee_breakdown | object | An object that contains the convenience fee breakdown details. Learn more about our convenience_fee_breakdown child object. |
cart_coupon_discount_amount | object | An object that contains the cart coupon discount amount details. Learn more about our cart_coupon_discount_amount child object. |
total_coupon_discount | object | An object that contains the total coupon discount details. Learn more about our total_coupon_discount child object. |
emi_type | strings | Type of EMI. Example: STANDARD Accepted values:
|
Issuer Offer Parameters [Child Object]
The table below lists the various parameters in the issuer_offer_parameters
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
program_type | String | Unique identifier of the issuer id in the Plural database. Example: 23 |
offer_id | String | Name of the Issuer. Example: INDUSIND CC |
offer_parameter_id | String | The type of the Issuer offering the offer. Accepted values:
|
Details [Child Object]
The table below lists the various parameters in the details
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
product_code | String | Unique Product identifier of the product. Example: redmi_1 |
product_display_name | string | Name of the Product. Example: Oneplus 13R |
brand_id | String | Unique brand identifier of the product. Example: 3 |
product_offer_parameters | array of objects | An array of objects that contains the product offer schemes for the product EMI details. Learn more about the product_offer_parameters child object. |
product_amount | object | An object that contains the product amount details. Learn more about the product_amount child object. |
product_coupon_discount_amount | object | An object that contains the product coupon discount amount details. Learn more about the product_coupon_discount_amount child object. |
subvention | object | An object that contains the subvention details. Learn more about the subvention child object. |
discount | object | An object that contains the product discount details. Learn more about the discount child object. |
brand_name | string | Name of the Brand. Example: Oneplus |
interest_amount | object | An object that contains the interest amount details. Learn more about the interest_amount child object. |
interest_rate | double | Rate of interest applied on the product. Example: 2 |
cart_coupon_discount_product_share | object | An object that contains the cart coupon discount product share details. Learn more about the cart_coupon_discount_product_share child object. |
Product Offer Parameters [Child Object]
The table below lists the various parameters in the product_offer_parameters
child object. This is part of the details
object.
Parameter | Type | Description |
---|---|---|
program_type | String | Type of the Program. Example: BRAND_EMI Accepted values:
|
offer_id | string | Unique identifier of the offer. Example: 309 |
offer_parameter_id | string | Unique offer parameter identifier. Example: 20 |
Product Amount [Child Object]
The table below lists the various parameters in the product_amount
child object. This is part of the details
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Product Coupon Discount Amount [Child Object]
The table below lists the various parameters in the product_coupon_discount_amount
child object. This is part of the details
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Subvention [Child Object]
The table below lists the various parameters in the subvention
child object. This is part of the details
object.
Parameter | Type | Description |
---|---|---|
subvention_type | String | Type of subvention. Example: INSTANT Accepted values:
|
offer_type | string | Type of the offer. Accepted values:
|
percentage | integer | Transaction amount is Paisa.
1000 |
amount | object | An object that contains the subvention amount details. Learn more about the amount child object. |
breakup | object | An object that contains the subvention breakup details. Learn more about the breakup child object. |
max_amount | object | An object that contains the maximum subvention amount details. Learn more about the max_amount child object. |
min_amount | object | An object that contains the minimum subvention amount details. Learn more about the min_amount child object. |
Amount [Child Object]
The table below lists the various parameters in the amount
child object. This is part of the subvention
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Breakup [Child Object]
The table below lists the various parameters in the breakup
child object. This is part of the subvention
object.
Parameter | Type | Description |
---|---|---|
brand | object | An object that contains the breakup details of the brand. Learn more about the brand child object. |
Brand [Child Object]
The table below lists the various parameters in the brand
child object. This is part of the breakup
object.
Parameter | Type | Description |
---|---|---|
amount | object | An object that contains the breakup amount details of the brand. Learn more about the amount child object. |
Amount [Child Object]
The table below lists the various parameters in the amount
child object. This is part of the brand
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Max Amount [Child Object]
The table below lists the various parameters in the max_amount
child object. This is part of the subvention
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Min Amount [Child Object]
The table below lists the various parameters in the min_amount
child object. This is part of the subvention
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Discount [Child Object]
The table below lists the various parameters in the discount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
discount_type | String | Type of discount. Possible values:
|
discount_string | string | The additional discount provided by the offering entity after a specific period. Example: 1000 |
percentage | Double | The discount percentage provided by the offering entity. Example: 16.90 |
amount | string | Discount amount. Example: 2000 |
max_amount | object | An object that contains the maximum discount amount details. Learn more about the max_amount child object. |
min_amount | object | An object that contains the minimum discount amount details. Learn more about the min_amount child object. |
discount_deferred_duration_value | integer | The duration value for the deferred discount. Example: |
discount_deferred_duration_type | string | Discount duration type deferred. Possible values:
|
breakup | object | An object that contains the product offer details with breakup. Learn more about the breakup child object. |
Max Amount [Child Object]
The table below lists the various parameters in the max_amount
child object. This is part of the discount
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Min Amount [Child Object]
The table below lists the various parameters in the min_amount
child object. This is part of the discount
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Breakup [Child Object]
The table below lists the various parameters in the breakup
child object. This is part of the discount
object.
Parameter | Type | Description |
---|---|---|
merchant | object | An object that contains the merchant breakup details. Learn more about the merchant child object. |
issuer | object | An object that contains the issure breakup details. Learn more about the issuer child object. |
brand | object | An object that contains the brand breakup details. Learn more about the brand child object. |
dealer | object | An object that contains the dealer breakup details. Learn more about the dealer child object. |
Merchant [Child Object]
The table below lists the various parameters in the merchant
child object. This is part of the breakup
object.
Parameter | Type | Description |
---|---|---|
amount | object | An object that contains the breakup amount details. Learn more about the amount child object. |
Issuer [Child Object]
The table below lists the various parameters in the issure
child object. This is part of the breakup
object.
Parameter | Type | Description |
---|---|---|
amount | object | An object that contains the breakup amount details. Learn more about the amount child object. |
Brand [Child Object]
The table below lists the various parameters in the brand
child object. This is part of the breakup
object.
Parameter | Type | Description |
---|---|---|
amount | object | An object that contains the breakup amount details. Learn more about the amount child object. |
Dealer [Child Object]
The table below lists the various parameters in the dealer
child object. This is part of the breakup
object.
Parameter | Type | Description |
---|---|---|
amount | object | An object that contains the breakup amount details. Learn more about the amount child object. |
Amount [Child Object]
The table below lists the various parameters in the amount
child object. This is part of the breakup
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Interest Amount [Child Object]
The table below lists the various parameters in the interest_amount
child object. This is part of the details
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Cart Coupon Discount Product Share [Child Object]
The table below lists the various parameters in the cart_coupon_discount_product_share
child object. This is part of the details
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Loan Amount [Child Object]
The table below lists the various parameters in the loan_amount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Total Discount Amount [Child Object]
The table below lists the various parameters in the total_discount_amount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Net Payment Amount [Child Object]
The table below lists the various parameters in the net_payment_amount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Monthly EMI Amount [Child Object]
The table below lists the various parameters in the monthly_emi_amount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Total EMI Amount [Child Object]
The table below lists the various parameters in the total_emi_amount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Interest Amount [Child Object]
The table below lists the various parameters in the interest_amount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Total Subvention Amount [Child Object]
The table below lists the various parameters in the total_subvention_amount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Processing Fee Details [Child Object]
The table below lists the various parameters in the processing_fee_details
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Convenience Fee Breakdown [Child Object]
The table below lists the various parameters in the convenience_fee_breakdown
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
fee_calculated_on_amount | object | An object that contains the fee calculation amount details. Learn more about the fee_calculated_on_amount child object. |
fee_amount | object | An object that contains the fee amount details. Learn more about the fee_amount child object. |
tax_amount | object | An object that contains the tax amount details. Learn more about the tax_amount child object. |
additional_fee_amount | object | An object that contains the additional fee amount details. Learn more about the additional_fee_amount child object. |
maximum_fee_amount | object | An object that contains the maximum fee amount details. Learn more about the maximum_fee_amount child object. |
applicable_fee_amount | object | An object that contains the applicable fee amount details. Learn more about the applicable_fee_amount child object. |
subvented_fee_amount | object | An object that contains the subvented fee amount details. Learn more about the subvented_fee_amount child object. |
Fee Calculated on Amount [Child Object]
The table below lists the various parameters in the fee_calculated_on_amount
child object. This is part of the convenience_fee_breakdown
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Fee Amount [Child Object]
The table below lists the various parameters in the fee_amount
child object. This is part of the convenience_fee_breakdown
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Tax Amount [Child Object]
The table below lists the various parameters in the tax_amount
child object. This is part of the convenience_fee_breakdown
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Additional Fee Amount [Child Object]
The table below lists the various parameters in the additional_fee_amount
child object. This is part of the convenience_fee_breakdown
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Maximum Fee Amount [Child Object]
The table below lists the various parameters in the maximum_fee_amount
child object. This is part of the convenience_fee_breakdown
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Applicable Fee Amount [Child Object]
The table below lists the various parameters in the applicable_fee_amount
child object. This is part of the convenience_fee_breakdown
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Subvented Fee Amount [Child Object]
The table below lists the various parameters in the subvented_fee_amount
child object. This is part of the convenience_fee_breakdown
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Cart Coupon Discount Amount [Child Object]
The table below lists the various parameters in the cart_coupon_discount_amount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Total Coupon Discount [Child Object]
The table below lists the various parameters in the total_coupon_discount
child object. This is part of the tenures
object.
Parameter | Type | Description |
---|---|---|
currency | String | Type of currency. Example: INR |
value | integer | Transaction amount is Paisa.
1000 |
Issuer Data [Child Object]
The table below lists the various parameters in the issure_data
object. This is part of the offer discovery response object.
Parameter | Type | Description |
---|---|---|
otp_length | integer | Length of the OTP. Example: 4 |
otp_time_in_sec | integer | OTP validity time in seconds. Example: 120 |
otp_retry_count | integer | Maximum OTP retry count. Example: |
is_consent_page_required | Boolean | Status of the required consent page.
|
consent_data | String | Transaction consent data. Example: |
terms_and_conditions | String | Transaction terms and conditions. Example: |
show_key_fact_statement | Boolean | Key fact statement status.
|
auth_type | String | Authentication type. Accepted values:
|
penny_transaction_amount | string | Applicable amount for penny transaction. Example: 100 |
is_tokenized_transaction_supported | Boolean | Tokenized transactions support status.
|
pan_number_last_digit_count | String | Last digit count of PAN. |
offer_validation_parameters_required | String | Parameters required in offer validation API. |