Object

Overview of the Plural EMI APIs sample response object.

EMI Calculator

Shown below is a sample response returned through our EMI Calculator API.

{
  "issuer": [
    {
      "list_emi_tenure": [
        {
          "offer_scheme": {
            "product_details": [
              {
                "schemes": [
                  {
                    "scheme_id": 1682,
                    "program_type": 112,
                    "is_scheme_valid": true
                  }
                ],
                "product_code": "SMG975FCWG",
                "product_amount": 550000,
                "subvention_cashback_discount": 11705,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 21500,
                "product_discount_percentage": 0,
                "subvention_type": 1
              },
              {
                "schemes": [],
                "product_code": "40",
                "product_amount": 550000,
                "subvention_cashback_discount": 0,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 0,
                "product_discount_percentage": 0
              }
            ],
            "emi_scheme": {
              "scheme_id": 1683,
              "program_type": 105,
              "is_scheme_valid": true
            }
          },
          "tenure_id": "3",
          "tenure_in_month": "3",
          "monthly_installment": 370652,
          "bank_interest_rate": 130000,
          "interest_pay_to_bank": 23661,
          "total_offerred_discount_cashback_amount": 11705,
          "loan_amount": 1088295,
          "auth_amount": 1088295
        },
        {
          "offer_scheme": {
            "product_details": [
              {
                "schemes": [
                  {
                    "scheme_id": 1682,
                    "program_type": 112,
                    "is_scheme_valid": true
                  }
                ],
                "product_code": "SMG975FCWG",
                "product_amount": 550000,
                "subvention_cashback_discount": 20266,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 37000,
                "product_discount_percentage": 0,
                "subvention_type": 1
              },
              {
                "schemes": [],
                "product_code": "40",
                "product_amount": 550000,
                "subvention_cashback_discount": 0,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 0,
                "product_discount_percentage": 0
              }
            ],
            "emi_scheme": {
              "scheme_id": 1683,
              "program_type": 105,
              "is_scheme_valid": true
            }
          },
          "tenure_id": "6",
          "tenure_in_month": "6",
          "monthly_installment": 186840,
          "bank_interest_rate": 130000,
          "interest_pay_to_bank": 41306,
          "total_offerred_discount_cashback_amount": 20266,
          "loan_amount": 1079734,
          "auth_amount": 1079734
        },
        {
          "offer_scheme": {
            "product_details": [
              {
                "schemes": [
                  {
                    "scheme_id": 1682,
                    "program_type": 112,
                    "is_scheme_valid": true
                  }
                ],
                "product_code": "SM-G975FCWG",
                "product_amount": 550000,
                "subvention_cashback_discount": 30756,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 56000,
                "product_discount_percentage": 0,
                "subvention_type": 1
              },
              {
                "schemes": [],
                "product_code": "40",
                "product_amount": 550000,
                "subvention_cashback_discount": 0,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 0,
                "product_discount_percentage": 0
              }
            ],
            "emi_scheme": {
              "scheme_id": 1683,
              "program_type": 105,
              "is_scheme_valid": true
            }
          },
          "tenure_id": "9",
          "tenure_in_month": "9",
          "monthly_installment": 125841,
          "bank_interest_rate": 140000,
          "interest_pay_to_bank": 63325,
          "total_offerred_discount_cashback_amount": 30756,
          "loan_amount": 1069244,
          "auth_amount": 1069244
        },
        {
          "offer_scheme": {
            "product_details": [
              {
                "schemes": [
                  {
                    "scheme_id": 1682,
                    "program_type": 112,
                    "is_scheme_valid": true
                  }
                ],
                "product_code": "SMG975FCWG",
                "product_amount": 550000,
                "subvention_cashback_discount": 39532,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 56000,
                "product_discount_percentage": 0,
                "subvention_type": 1
              },
              {
                "schemes": [],
                "product_code": "40",
                "product_amount": 550000,
                "subvention_cashback_discount": 0,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 0,
                "product_discount_percentage": 0
              }
            ],
            "emi_scheme": {
              "scheme_id": 1683,
              "program_type": 105,
              "is_scheme_valid": true
            }
          },
          "tenure_id": "12",
          "tenure_in_month": "12",
          "monthly_installment": 95215,
          "bank_interest_rate": 140000,
          "interest_pay_to_bank": 82112,
          "total_offerred_discount_cashback_amount": 39532,
          "loan_amount": 1060468,
          "auth_amount": 1060468
        },
        {
          "offer_scheme": {
            "product_details": [
              {
                "schemes": [
                  {
                    "scheme_id": 1682,
                    "program_type": 112,
                    "is_scheme_valid": true
                  }
                ],
                "product_code": "SMG975FCWG",
                "product_amount": 550000,
                "subvention_cashback_discount": 60209,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 0,
                "product_discount_percentage": 0,
                "subvention_type": 1
              },
              {
                "schemes": [],
                "product_code": "40",
                "product_amount": 550000,
                "subvention_cashback_discount": 0,
                "product_discount": 0,
                "subvention_cashback_discount_percentage": 0,
                "product_discount_percentage": 0
              }
            ],
            "emi_scheme": {
              "scheme_id": 1683,
              "program_type": 105,
              "is_scheme_valid": true
            }
          },
          "tenure_id": "18",
          "tenure_in_month": "18",
          "monthly_installment": 64867,
          "bank_interest_rate": 150000,
          "interest_pay_to_bank": 127815,
          "total_offerred_discount_cashback_amount": 60209,
          "loan_amount": 1039791,
          "auth_amount": 1039791
        }
      ],
      "issuer_name": "HDFC",
      "is_debit_emi_issuer": false
    }
  ],
  "response_code": 1,
  "response_message": "SUCCESS"
}

The table below lists the various parameters returned in the EMI Calculator response objects.

ParameterTypeDescription
issuerarray of objectsAn array of object that contains the issuing bank EMI details.

Learn more about the issuer child object.
response_codeintegerStatus of the API processing.

Note: Value 1 denotes success.

Example: 1
response_messagestringMessage corresponding to the response code.

Example: SUCCESS

Issuer [Child Object]

The table below lists the various parameters in the issuer child object. This object is part of the EMI Calculator sample response object.

ParameterTypeDescription
list_emi_tenurearray of objectsAn array of object that contains the EMI tenure details of each issuer.

Learn more about the list_emi_tenure child object.
issuer_namestringBank name.

Example: HDFC
is_debit_emi_issuerbooleanIdentifier of the issuer type.

Example: true

Accepted values:
  • true:
  • false:

List EMI Tenure [Child Object]

The table below lists the various parameters in the list_emi_tenure child object. This object is part of the issuer object.

ParameterTypeDescription
offer_schemeobjectAn object that contains the offer applicable details on each product.

Learn more about offer_scheme child object.
tenure_idstringTenure ID specified by pine labs.

Example: 3
tenure_in_monthstringEMI tenure in months specified by Pine Labs.

Example: 18
monthly_installmentintegerMonthly instalment amount in Paisa.

Example: 2345
bank_interest_rateintegerBank interest rate.

Example: 150000
interest_pay_to_bankintegerPayable interest to Bank in Paisa.

Example: 127815
total_offerred_discount_cashback_amountintegerTotal discount applicable on cart value.

Example: 60209
loan_amountintegerThe amount in paisa for which the loan is approved.

Example: 1039791
auth_amountintegerBank authorization amount in paisa.

Example: 1039791

Offer Scheme [Child Object]

The table below lists the various parameters in the offer_scheme child object. This object is part of the list_emi_tenure object.

ParameterTypeDescription
product_detailsarray of objectAn array of object that contains the product details.

Learn more about the product_details child object.
emi_schemeobjectAn object that contains the EMI scheme details.

Learn more about the emi_scheme child object.
Product Details [Child Object]

The table below lists the various parameters in the product_details child object. This object is part of the offer_scheme object.

ParameterTypeDescription
schemesarray of objectAn array of objects that contains the list of program applicable on the product.

Learn more about schemes child object.
product_codestringProduct code.

Example: 40
product_amountintegerThe amount on the product.

Example: 550000
subvention_cashback_discount_percentageintegerSubvention cashback discount in percentage.

Example: 0
product_discount_percentageintegerDiscount on the product in percentage.

Example: 0
subvention_typeintegerOffer type.

Accepted values:
  • 1: No cost EMI
  • 2: Low cost EMI
  • 3: Standard EMI
additional_cashbackstringAdditional cashback.

Example: 0
bank_interest_rateintegerBank interest rate in Paisa.

Example: 0
bank_interest_rate_percentageintegerBank interest rate in Percentage.

Example: 0
EMI Schemes [Child Object]

The table below lists the various parameters in the emi_schemes child object. This object is part of the offer_scheme object.

ParameterTypeDescription
scheme_idintegerApplicable scheme ID on the product.

Example: 1683
program_typeintegerScheme type.

Accepted values:
  • 105: Bank EMI
  • 106: Brand EMI
  • 108: Product Discount
  • 112: Subvention Discount
is_scheme_validbooleanStatus of the scheme validation.

Accepted value:
  • true:
  • false:
Schemes [Child Object]

The table below lists the various parameters in the schemes child object. This object is part of the product_details object.

ParameterTypeDescription
scheme_idintegerApplicable scheme ID on the product.

Example: 1683
program_typeintegerScheme type.

Accepted values:
  • 105: Bank EMI
  • 106: Brand EMI
  • 108: Product Discount
  • 112: Subvention Discount
is_scheme_validbooleanStatus of the scheme validation.

Accepted value:
  • true:
  • false:

Scheme Validation

Shown below is a sample response returned through our Scheme Validation API.

{
  "response_code": 1,
  "response_message": "SUCCESS"
}

The table below lists the various parameters returned in the Scheme Validation response objects.

ParameterTypeDescription
response_codeintegerStatus of the API processing.

Note: Value 1 denotes success.

Example: 1
response_messagestringMessage corresponding to the response code.

Example: SUCCESS

Accept Payment

Shown below is a sample response returned through our Accept Payment API.

{
  "token": "S03%2fbPRIyC1A6jR%2bmmQrUeW4oQEL4vFBA722BtwavAdQuw%3d",
  "response_code": 1,
  "response_message": "SUCCESS"
}

The table below lists the various parameters returned in the Scheme Validation response objects.

ParameterTypeDescription
tokenstringUnique token created for a transaction.

Example: S03%2fbPRIyC1A6jR%2bmmQrUeW4oQEL4vFBA722BtwavAdQuw%3d

Note: You need to pass this token in our Process Payment API.
response_codeintegerStatus of the API processing.

Note: Value 1 denotes success.

Example: 1
response_messagestringMessage corresponding to the response code.

Example: SUCCESS

Process Payment

Shown below is a sample response returned through our Process Payment API.

{
  "response_code": 1,
  "response_message": "SUCCESS",
  "redirect_url": "http://hostname:port/pinepg/v2/process/payment?token=848RFsu%2bRnNcSsaZdzEgkeosvCc2o5lK TV4uKJF%2fcjE%3d"
}

The table below lists the various parameters returned in the Scheme Validation response objects.

ParameterTypeDescription
response_codeintegerStatus of the API processing.

Note: Value 1 denotes success.

Example: 1
response_messagestringMessage corresponding to the response code.

Example: SUCCESS
redirect_urlstringPlural seamless checkout URL. Navigate your customers to this URL to accept payment.

Example: http\://hostname:port/api/v2/process/payment?token=ubrjAgbVaJVrGz67y%2fZCjCveYWNymE7ULAlOO7FCbz4% 3d