Pre-check Eligibility API

The Check Eligibility API is used to determine a customer's eligibility for cardless EMI transactions before initiating the process. This API cross-references customer details against a list of issuers associated with the merchant and returns details about the supported issuers and their EMI offerings if the customer is eligible.

API Details

• API Name: Check Eligibility
• Path: /api/v1/eligibility-check
• HTTP Method: POST
• Content Type: application/json
• Environments:
  • UAT: https://pluralqa.pinepg.in/v1/pre-eligibility-check
  • Production: https://pinepg.in/api/v1/eligibility-check

Sample Request

{
  "merchant": {
    "id": 4000,
    "access_code": "a416d73b-49c9-4917-a62a-d1671XXXXXXXX",
    "name": "Test Merchant"
  },
  "customer": {
    "phone": {
      "country_code": "+91",
      "national_number": "9571111111"
    }
  },
  "transaction_amount": {
    "currency_code": "INR",
    "amount": 1200000
  }
}

Request Parameters

Parameter Name	Type	Description	Mandatory/Optional
merchant	Object	Contains merchant identification details.	Mandatory
customer	Object	Contains customer identification details.	Mandatory
transaction_amount	Object	Contains transaction amount details.	Mandatory

Merchant

Parameter Name	Type	Description	Mandatory/Optional
id	int	Merchant ID provided by Pine Labs.	Mandatory
access_code	string	Merchant access code provided by Pine Labs.	Mandatory
name	string	Merchant name.	Optional

Customer

Parameter Name	Type	Description	Mandatory/Optional
name	string	Customer's name.	Optional
phone	Object	Customer's phone details.	Mandatory

Phone

Parameter Name	Type	Description	Mandatory/Optional
country_code	string	Country code of the customer.	Mandatory
national_number	string	Customer's phone number.	Mandatory

Transaction Amount

Parameter Name	Type	Description	Mandatory/Optional
currency_code	string	Currency code of the transaction	Mandatory
amount	long	Transaction amount in paise.	Mandatory

Sample Response

{
  "issuers": [
    {
      "name": "AXIO",
      "eligible": true,
      "existing_customer": false,
      "emi_data": [
        {
          "tenure": 3,
          "interest_rate": 0.0,
          "no_cost_emi": true,
          "emi_amount": {
            "currency_code": "INR",
            "amount": 400000
          }
        },
        {
          "tenure": 6,
          "interest_rate": 0.0,
          "no_cost_emi": true,
          "emi_amount": {
            "currency_code": "INR",
            "amount": 200000
          }
        }
      ]
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
issuers	Array of objects	Contains details about issuing banks and EMI details

issuers

Parameter Name	Type	Description
name	string	Name of the issuer.
eligible	Boolean	Indicates whether the customer is eligible for EMI.
existing_customer	Boolean	Indicates whether the customer is an existing customer.
emi_data	Object	Contains details like tenure, interest rate, and EMI amount.

emi_data

Parameter Name	Type	Description
tenure	int	EMI tenure in months.
interest_rate	double	EMI interest rate.
no_cost_emi	Boolean	Indicates a no-cost EMI option
emi_amount	Object	Details of the EMI amount.

Error Codes

Add error codes specific to this API here.