Offer Discovery (v2)
POST
/api/affordability/v2/offer/discoveryUse this API to discover offers available on cart amount or product and calculate the EMI. V2 returns an entity-based response structure with support for multiple entity types including UPI.
Requires
Bearer token. Get token →Request Body
| Name | Type | Description |
|---|---|---|
order_amount | objectrequired | An object that contains the transaction amount details. |
value | integerrequired | The transaction amount in Paisa. Minimum value: 100 (₹1). Maximum value: 100000000 (₹10 lakh). |
currency | stringrequired | Type of currency. |
product_details | object[] | Mandatory for Brand EMI. An object that contains product details. |
product_code | stringrequired | Unique identifier for the product. |
product_amount | object | Mandatory Object. An object that contains product amount. |
product_coupon_discount_amount | object | An object that contains the product coupon discount amount details. |
cart_coupon_discount_amount | object | An object that contains the cart coupon discount amount details. |
value | integerrequired | The transaction amount in Paisa. |
currency | stringrequired | Type of currency. |
issuer | object | An object that contains the issuer details. |
bin | string | Bank Identification Number, First 8 digits of your Card. Has to be 8 digits. Note: Passing the card information will filter the results based on the specific BIN. |
id | string | Mandatory for EMI with Downpayment. Unique Identifier of the issuer. |
name | string | Mandatory for EMI with Downpayment. Name of the issuer. |
issuer_type | CC_BANK | DC_BANK | CARDLESS_BANK | CC_NBFC | DC_NBFC | CARDLESS_NBFC | NTB | NTB_BANK | NTB_NBFC | Mandatory for EMI with Downpayment. The category of the issuer. CC_BANKDC_BANKCARDLESS_BANKCC_NBFCDC_NBFCCARDLESS_NBFCNTBNTB_BANKNTB_NBFC |
downpayment_details | object | Mandatory for EMI with Downpayment. An object that contains the downpayment amount details. |
downpayment_amount | object | An object that contains the downpayment amount details. |
payment_options | object | An object that contains the details of the payment options. You can use either |
card_details | object | An object that contains the card details. |
card_token_details | object | An object that contains the card token details. |
customer_details | object | An object that contains the customer details. |
customer_id | string | Mandatory when |
Response
| Name | Type | Description |
|---|---|---|
entities | OfferDiscoveryEntityDetailV2[] | List of Entities offering the Offer. |
entity_id | string | Entity Id. |
entity_name | string | Entity Name. |
entity_display_name | string | Display Name of the Entity offering the Offer. |
entity_type | UPI | CC_BANK | DC_BANK | CARDLESS_BANK | CC_NBFC | DC_NBFC | CARDLESS_NBFC | NTB | NTB_BANK | NTB_NBFC | Type of Entity. UPICC_BANKDC_BANKCARDLESS_BANKCC_NBFCDC_NBFCCARDLESS_NBFCNTBNTB_BANKNTB_NBFC |
entity_priority | integer | Priority of the Issuer offering the Offer. |
tenures | EntityTenureDetail[] | List of Tenures available for the Offer. |
entity_data | object | Data related to the Entity (OTP, consent, etc.). |
Status Codes
200 | 200 |
400 | 400 |
422 | 422 |
Request
curl -X POST "https://api.pluralpay.in/api/affordability/v2/offer/discovery" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"order_amount": {
"currency": "INR",
"value": 1200000
},
"issuer": {
"bin": "60100000"
}
}'Run this request
200 OK
{
"entities": [
{
"entity_id": "37",
"entity_name": "UPI",
"entity_display_name": "UPI",
"entity_type": "UPI",
"entity_priority": 26,
"tenures": [
{
"tenure_id": "7",
"name": "No EMI Only Cashback",
"tenure_type": "MONTH",
"tenure_value": 0,
"issuer_offer_parameters": [
{
"program_type": "MERCHANT_BANK_OFFER",
"offer_id": "6037",
"offer_parameter_id": "v1-37-10-7-5-6037-287151"
}
],
"details": [
{
"product_code": "ICB_BOSCH_001",
"brand_id": "7",
"product_offer_parameters": [
{
"program_type": "MERCHANT_BANK_OFFER",
"offer_id": "6037",
"offer_parameter_id": "v1-37-10-7-5-6037-287151"
}
],
"product_amount": {
"value": 50000,
"currency": "INR"
},
"product_coupon_discount_amount": {
"value": 50000,
"currency": "INR"
},
"subvention": {
"subvention_type": "INSTANT",
"offer_type": "NO_COST",
"amount": {
"value": 50000,
"currency": "INR"
},
"breakup": {
"merchant": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"issuer": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"brand": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"dealer": {
"amount": {
"value": 50000,
"currency": "INR"
}
}
},
"max_amount": {
"value": 50000,
"currency": "INR"
},
"min_amount": {
"value": 50000,
"currency": "INR"
}
},
"discount": {
"discount_type": "INSTANT",
"percentage": 10,
"amount": {
"value": 50000,
"currency": "INR"
},
"max_amount": {
"value": 50000,
"currency": "INR"
},
"min_amount": {
"value": 50000,
"currency": "INR"
},
"discount_deferred_duration_type": "DAY",
"breakup": {
"merchant": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"issuer": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"brand": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"dealer": {
"amount": {
"value": 50000,
"currency": "INR"
}
}
}
},
"interest_amount": {
"value": 50000,
"currency": "INR"
},
"interest_rate": 0,
"cart_coupon_discount_product_share": {
"value": 50000,
"currency": "INR"
},
"downpayment_amount": {
"value": 50000,
"currency": "INR"
},
"after_downpayment_reduced_product_amount": {
"value": 50000,
"currency": "INR"
}
}
],
"offers": [
{
"offer_ranking": 1,
"issuer_offer_parameters": [
{
"program_type": "MERCHANT_BANK_OFFER",
"offer_id": "6037",
"offer_parameter_id": "v1-37-10-7-5-6037-287151"
}
],
"details": [
{
"product_code": "ICB_BOSCH_001",
"brand_id": "7",
"product_offer_parameters": [
{
"program_type": "MERCHANT_BANK_OFFER",
"offer_id": "6037",
"offer_parameter_id": "v1-37-10-7-5-6037-287151"
}
],
"product_amount": {
"value": 50000,
"currency": "INR"
},
"product_coupon_discount_amount": {
"value": 50000,
"currency": "INR"
},
"subvention": {
"subvention_type": "INSTANT",
"offer_type": "NO_COST",
"amount": {
"value": 50000,
"currency": "INR"
},
"breakup": {
"merchant": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"issuer": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"brand": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"dealer": {
"amount": {
"value": 50000,
"currency": "INR"
}
}
},
"max_amount": {
"value": 50000,
"currency": "INR"
},
"min_amount": {
"value": 50000,
"currency": "INR"
}
},
"discount": {
"discount_type": "INSTANT",
"percentage": 10,
"amount": {
"value": 50000,
"currency": "INR"
},
"max_amount": {
"value": 50000,
"currency": "INR"
},
"min_amount": {
"value": 50000,
"currency": "INR"
},
"discount_deferred_duration_type": "DAY",
"breakup": {
"merchant": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"issuer": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"brand": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"dealer": {
"amount": {
"value": 50000,
"currency": "INR"
}
}
}
},
"interest_amount": {
"value": 50000,
"currency": "INR"
},
"interest_rate": 0,
"cart_coupon_discount_product_share": {
"value": 50000,
"currency": "INR"
},
"downpayment_amount": {
"value": 50000,
"currency": "INR"
},
"after_downpayment_reduced_product_amount": {
"value": 50000,
"currency": "INR"
}
}
],
"discount": {
"discount_type": "INSTANT",
"percentage": 10,
"amount": {
"value": 50000,
"currency": "INR"
},
"max_amount": {
"value": 50000,
"currency": "INR"
},
"min_amount": {
"value": 50000,
"currency": "INR"
},
"discount_deferred_duration_type": "DAY",
"breakup": {
"merchant": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"issuer": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"brand": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"dealer": {
"amount": {
"value": 50000,
"currency": "INR"
}
}
}
},
"cashback": {
"cashback_type": "INSTANT",
"amount": {
"value": 50000,
"currency": "INR"
},
"max_amount": {
"value": 50000,
"currency": "INR"
},
"min_amount": {
"value": 50000,
"currency": "INR"
},
"breakup": {
"merchant": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"issuer": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"brand": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"dealer": {
"amount": {
"value": 50000,
"currency": "INR"
}
}
}
},
"loan_amount": {
"value": 50000,
"currency": "INR"
},
"auth_amount": {
"value": 50000,
"currency": "INR"
},
"total_discount_amount": {
"value": 50000,
"currency": "INR"
},
"total_cashback_amount": {
"value": 50000,
"currency": "INR"
},
"net_payment_amount": {
"value": 50000,
"currency": "INR"
},
"monthly_emi_amount": {
"value": 50000,
"currency": "INR"
},
"total_emi_amount": {
"value": 50000,
"currency": "INR"
},
"interest_amount": {
"value": 50000,
"currency": "INR"
},
"advance_emi_months": [],
"split_emi_amount": {
"value": 50000,
"currency": "INR"
},
"total_subvention_amount": {
"value": 50000,
"currency": "INR"
},
"interest_rate_percentage": 0,
"processing_fee_details": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"total_down_payment_amount": {
"value": 50000,
"currency": "INR"
},
"net_dealer_disbursement_amount": {
"value": 50000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_calculated_on_amount": {
"value": 50000,
"currency": "INR"
},
"fee_amount": {
"value": 50000,
"currency": "INR"
},
"tax_amount": {
"value": 50000,
"currency": "INR"
},
"additional_fee_amount": {
"value": 50000,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 50000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 50000,
"currency": "INR"
},
"subvented_fee_amount": {
"value": 50000,
"currency": "INR"
}
},
"cart_coupon_discount_amount": {
"value": 50000,
"currency": "INR"
},
"total_coupon_discount": {
"value": 50000,
"currency": "INR"
},
"downpayment_details": {
"downpayment_amount": {
"value": 50000,
"currency": "INR"
}
},
"emi_type": "STANDARD",
"is_mobile_number_required_for_eligibility": false,
"is_offer_auto_applied": true,
"offer_eligibility_channel_list": []
}
],
"discount": {
"discount_type": "INSTANT",
"percentage": 10,
"amount": {
"value": 50000,
"currency": "INR"
},
"max_amount": {
"value": 50000,
"currency": "INR"
},
"min_amount": {
"value": 50000,
"currency": "INR"
},
"discount_deferred_duration_type": "DAY",
"breakup": {
"merchant": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"issuer": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"brand": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"dealer": {
"amount": {
"value": 50000,
"currency": "INR"
}
}
}
},
"loan_amount": {
"value": 50000,
"currency": "INR"
},
"auth_amount": {
"value": 50000,
"currency": "INR"
},
"total_discount_amount": {
"value": 50000,
"currency": "INR"
},
"net_payment_amount": {
"value": 50000,
"currency": "INR"
},
"monthly_emi_amount": {
"value": 50000,
"currency": "INR"
},
"total_emi_amount": {
"value": 50000,
"currency": "INR"
},
"interest_amount": {
"value": 50000,
"currency": "INR"
},
"advance_emi_months": [],
"split_emi_amount": {
"value": 50000,
"currency": "INR"
},
"total_subvention_amount": {
"value": 50000,
"currency": "INR"
},
"processing_fee_details": {
"amount": {
"value": 50000,
"currency": "INR"
}
},
"total_down_payment_amount": {
"value": 50000,
"currency": "INR"
},
"net_dealer_disbursement_amount": {
"value": 50000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_calculated_on_amount": {
"value": 50000,
"currency": "INR"
},
"fee_amount": {
"value": 50000,
"currency": "INR"
},
"tax_amount": {
"value": 50000,
"currency": "INR"
},
"additional_fee_amount": {
"value": 50000,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 50000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 50000,
"currency": "INR"
},
"subvented_fee_amount": {
"value": 50000,
"currency": "INR"
}
},
"cart_coupon_discount_amount": {
"value": 50000,
"currency": "INR"
},
"total_coupon_discount": {
"value": 50000,
"currency": "INR"
},
"downpayment_details": {
"downpayment_amount": {
"value": 50000,
"currency": "INR"
}
},
"emi_type": "STANDARD"
}
],
"entity_data": {
"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": false,
"auth_type": "OTP",
"penny_transaction_amount": {
"value": 50000,
"currency": "INR"
},
"is_tokenized_transaction_supported": false,
"pan_number_last_digit_count": "3",
"offer_validation_parameters_required": [
"card_details__registered_mobile_number",
"card_details__card_number"
]
}
}
}
]
}