Offer Discovery

POST/api/affordability/v1/offer/discovery

Use this API to discover offers available on cart amount or product and calculate the EMI.

View as Markdown Open in ChatGPT Open in Claude Open in Perplexity

Requires Bearer token. Get token →

Request Body

Name	Type	Description
`order_amount`	`object`required	An object that contains the transaction amount details.
`value`	`integer`required	The transaction amount in Paisa. Minimum value: 100 (₹1). Maximum value: 100000000 (₹10 lakh).
`currency`	`string`required	Type of currency.
`product_details`	`object[]`	Mandatory for Brand EMI. An object that contains product details.
`product_code`	`string`required	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`	`integer`required	The transaction amount in Paisa.
`currency`	`string`required	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` or `card_token_details` as a payment option.
`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 `token_id` is included in the `card_token_details` object. Unique identifier of the customer in the Pine Labs Online database. Minimum length: 1 character. Maximum length: 19 characters.

Response

Name	Type	Description
`issuers`	`IssuerOffer[]`	List of issuers with available offers.
`id`	`string`	Unique identifier of the issuer id in the Pine Labs Online database.
`name`	`string`	Name of the Issuer.
`display_name`	`string`	Name of the issuer offering the offer.
`issuer_type`	`CC_BANK \| DC_BANK \| CARDLESS_BANK \| CC_NBFC \| DC_NBFC \| CARDLESS_NBFC \| NTB \| NTB_BANK \| NTB_NBFC`	The type of the Issuer offering the offer. `CC_BANKDC_BANKCARDLESS_BANKCC_NBFCDC_NBFCCARDLESS_NBFCNTBNTB_BANKNTB_NBFC`
`priority`	`integer`	The priority of the issuer providing the offer.
`tenures`	`Tenure[]`	Available EMI tenures for this issuer.
`issuer_data`	`object`	Issuer-specific data including OTP and consent details.

Status Codes

`200`	200
`400`	400
`422`	422

Example:

Request

curl -X POST "https://api.pluralpay.in/api/affordability/v1/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

Bearer token

Request body (JSON)

200 OK

{
  "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": [
            {
              "product_code": "redmi_1",
              "product_display_name": "Redmi Note 14 5G",
              "brand_id": "3",
              "brand_name": "Xiaomi",
              "product_offer_parameters": [
                {
                  "program_type": "BRAND_OFFER",
                  "offer_id": "309",
                  "offer_parameter_id": "20"
                }
              ],
              "product_amount": {
                "currency": "INR",
                "value": 2000000
              },
              "product_coupon_discount_amount": {
                "currency": "INR",
                "value": 1000
              },
              "subvention": {
                "subvention_type": "INSTANT",
                "offer_type": "NO_COST",
                "percentage": 5,
                "amount": {
                  "currency": "INR",
                  "value": 85714
                },
                "breakup": {
                  "brand": {
                    "amount": {
                      "currency": "INR",
                      "value": 85714
                    }
                  }
                },
                "max_amount": {
                  "currency": "INR"
                },
                "min_amount": {
                  "currency": "INR"
                }
              },
              "discount": {
                "discount_type": "INSTANT",
                "percentage": 10,
                "amount": {
                  "currency": "INR",
                  "value": 200000
                },
                "max_amount": {
                  "currency": "INR",
                  "value": 200000
                },
                "breakup": {
                  "merchant": {
                    "amount": {
                      "currency": "INR",
                      "value": 100000
                    }
                  },
                  "brand": {
                    "amount": {
                      "currency": "INR",
                      "value": 100000
                    }
                  }
                },
                "discount_deferred_duration_type": "DAY"
              },
              "interest_amount": {
                "currency": "INR"
              },
              "interest_rate": 16,
              "cart_coupon_discount_product_share": {
                "currency": "INR"
              },
              "downpayment_amount": {
                "currency": "INR",
                "value": 200000
              },
              "after_downpayment_reduced_product_amount": {
                "currency": "INR",
                "value": 200000
              },
              "bundle_id": "BUNDLE_002_OE3"
            }
          ],
          "discount": {
            "discount_type": "INSTANT",
            "percentage": 10,
            "amount": {
              "currency": "INR",
              "value": 200000
            },
            "max_amount": {
              "currency": "INR",
              "value": 400000
            },
            "breakup": {
              "merchant": {
                "amount": {
                  "currency": "INR",
                  "value": 100000
                }
              },
              "brand": {
                "amount": {
                  "currency": "INR",
                  "value": 100000
                }
              },
              "issuer": {
                "amount": {
                  "currency": "INR"
                }
              },
              "dealer": {
                "amount": {
                  "currency": "INR"
                }
              }
            },
            "discount_deferred_duration_type": "DAY"
          },
          "auth_amount": {
            "currency": "INR",
            "value": 1200000
          },
          "loan_amount": {
            "currency": "INR",
            "value": 1200000
          },
          "total_discount_amount": {
            "currency": "INR",
            "value": 200000
          },
          "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
          },
          "total_subvention_amount": {
            "currency": "INR"
          },
          "split_emi_display_name": "Apple Live",
          "split_emi_amount": {
            "currency": "INR",
            "value": 2358490
          },
          "split_emi_percentage": 25,
          "interest_rate_percentage": 16,
          "processing_fee_details": {
            "percentage": 0,
            "amount": {
              "currency": "INR",
              "value": 19900
            }
          },
          "processing_fee_amount": {
            "currency": "INR",
            "value": 19900
          },
          "convenience_fee_breakdown": {
            "fee_calculated_on_amount": {
              "currency": "INR"
            },
            "fee_amount": {
              "currency": "INR",
              "value": 100
            },
            "tax_amount": {
              "currency": "INR",
              "value": 19
            },
            "additional_fee_amount": {
              "currency": "INR",
              "value": 10
            },
            "maximum_fee_amount": {
              "currency": "INR",
              "value": 99999999
            },
            "applicable_fee_amount": {
              "currency": "INR",
              "value": 129
            },
            "subvented_fee_amount": {
              "currency": "INR"
            }
          },
          "cart_coupon_discount_amount": {
            "currency": "INR"
          },
          "total_coupon_discount": {
            "currency": "INR"
          },
          "total_down_payment_amount": {
            "currency": "INR",
            "value": 200000
          },
          "downpayment_details": {
            "downpayment_amount": {
              "currency": "INR",
              "value": 200000
            }
          },
          "emi_type": "STANDARD"
        }
      ],
      "issuer_data": {
        "otp_length": 5,
        "otp_time_in_sec": 180,
        "otp_retry_count": 5,
        "is_consent_page_required": true,
        "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,
        "pan_number_last_digit_count": 3
      }
    }
  ]
}