Skip to main content

List of EMIs [v3]​

This API returns a list of EMI options that can be shown to the user to select on your checkout. The list only includes EMI options that are enabled for you. The API also returns if the EMI has any offers or additional charges to be levied.

Request Body required
    order_id string

    The order for which you want to display the list of EMIs. If you don't pass this field, then no offer or additional charge information will be calculated. If you pass this field, then total_amount and currency are not required.

    payment_mode_code string

    Possible values: [credit_card_emi, debit_card_emi, cardless_emi, all]

    The type of EMI for which you want to fetch the schemes, if key is not passed that will be considered as "all".

    payment_mode_details object
    account_holder object

    pass this to perform eligibility checks for Cardless EMI

    mobile_number string required

    The mobile number to perform eligibility check for Cardless EMI

    membership_card string

    The membership card number of the account holder

    pan_card string

    The PAN card number of the account holder

    card_input_type string

    Possible values: [card_pan, merchant_network_token, nimbbl_token_id]

    Type of card input (e.g., card_pan)

    card object
    card_no string

    This is the card number typically between 15-19 digits, you should only pass this from your server if you are PCI-DSS certified

    total_amount number

    The amount for which you want to display the list of EMIs and calculate the offer and additional charges. You only need to pass the amount if you don't pass the order_id.

    currency string

    Default value: INR

    The currency code in ISO-4217 format, e.g., USD, INR, GBP. You only need to pass the currency if you don't pass the order_id.

Responses

When the list of EMIs is successfully fetched, the response will be as below

Schema
    emi object[]

    This is the list of EMI options available. for some Cardless EMI issuers, the scheme selection happens at the issuer's site. in such scenarios, those issuers will have redirect_for_schemes as true and will contain a single scheme in schemes with tenure as 0 which will contain information such as additional charges and offer details

  • Array [
    • issuer string

    This is the name of the bank issuing the EMI.

    issuer_code string

    This is the code of the issuing bank. for Cardless EMI, this will be the value that has to be passed in v3/intiate-payment

    logo string

    This is the URL to the bank's logo.

    payment_initiation string[]

    Possible values: [mobile_number, memebership_card, pan_card]

    additional data required and to be passed in account_holder in v3/initiate-payment

    eligibility string

    Possible values: [not_checked, eligible, ineligible]

    eligibility status based on mobile number passed in request, will be not_checked if not passed. this field will only be present in case of Cardless EMI

    redirect_for_schemes boolean

    will only be present of Cardless EMI, will be true if Issuer requires scheme selection on their site.

    health_status string

    Possible values: [up, fluctuating, down]

    This is the health status of the EMI offer.

    schemes object[]

    This is the list of EMI schemes offered by the issuer.

  • Array [
    • tenure number

    This is the the number of EMI installments.

    frequency string

    Possible values: [daily, weekly, monthly]

    This is the frequency of payments

    subvention_type string

    Possible values: [standard, no_cost, low_cost]

    The type of subvention.

    processing_fee_data object
    fee number

    The processing fee.

    gst_exclusive boolean

    This tells us whether the GST is exclusive.

    grand_total_amount number

    The total amount to be paid over the tenure.

    additional_charges number

    Any additional charges applicable.

    interest_discount number

    The discount on the interest rate.

    cashback_amount number

    The cashback amount.

    installment_amount number

    The amount of each installment.

    interest_amount number

    The total interest amount.

    interest_rate number

    The interest rate applicable.

    subvented_interest_rate number

    The subvented interest rate.

    card_network_code string[]

    The card networks applicable for this EMI offer.

    t_and_c string

    URL to the terms and conditions.

    kfs string

    URL to the Key Fact Statement.

    offer object
    offer_id string

    Unique identifier for the offer.

    offer_description string

    Description of the offer.

    offer_discount number

    The discount provided by the offer.

    offer_type string

    Possible values: [fixed, percentage]

    Type of the offer discount.

    offer_start_date date-time

    Start date of the offer.

    offer_end_date date-time

    End date of the offer.

    minimum_order_amount number

    The minimum order amount to avail the offer.

    max_offer_discount number

    The maximum discount offered.

    discount_amount number

    The final discount amount applied.

    t_and_c string

    URL to the offer's terms and conditions.

  • ]
  • ]
    • next object[]

    The next array provides a recommendation for the next API call to be made, where multiple options are available, all of these are provided.

  • Array [
    • anyOf
    action string required

    Possible values: [get_bin_data]

    If you want to check details of the card entered by your customer on your checkout, then you can call this API

    url string required

    Possible values: [/api/v3/get-bin-data]

    This is the end point of the API that needs to be called for the above action, you will need to append the baseurl as provided in this doc

  • ]
Loading...