---
page_title: Eligibility API
product: HyperCredit
platform: Web
page_source: https://juspay.io/in/docs/hyper-credit/web/hypercredit-checkout/eligibility-api
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/hyper-credit/llms.txt
---


# **Eligibility API** 



The Eligibility API is used to determine lender-wise eligibility for a customer using the phone number and order amount passed in the request payload. Based on the response, your application can dynamically update the checkout UI to reflect the customer's approval status. [Click here to know more.](/ec-api/docs/base-integration/eligibility-api)


### **Pre-approved Display Condition** 



The **"Pre-approved"**  tag should only be displayed if at least one payment method exists. 

> **Note**
> For Pay-In-3, the payment method should be`"{Lender_name}_LSP"` indicating that at least one Loan Service Provider (LSP) has pre-approved the user for financing.




| Environment | End Point | Method |
|---|---|---|
| UAT | https://sandbox.juspay.in/customers/{customer_id}/eligibility | POST |
| Production | https://api.juspay.in/customers/{customer_id}/eligibility | POST |


**Request Payload:** 


#### Sample Request Code Snippet:

```sample request
curl --location --request POST 'https://api.juspay.in/customers/testcustomer/eligibility' \
--header 'Authorization: Basic NTlEQzNG****QzE1Og==' \
--header 'x-routing-id: customer_1122'\
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'amount=1' \
--data-urlencode 'gateway_reference_id=test' 

```



| Key | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| mobile_number | String | No | Unique identifier for the order generated by the merchant |
| amount | String | Yes | Order amount in the smallest currency unit (e.g., paise for INR) |
| gateway_reference_id | String | No | Gateway reference ID |


**Response Payload:** 


#### Sample Response Code Snippet:

```sample response
{
    "payment_methods_eligibility": [
        {
            "status": "SUCCESS",
            "description": "ShopSe",
            "eligibility_strategy": "USER",
            "payment_method": "SHOPSE",
            "payment_method_type": "CONSUMER_FINANCE",
            "is_eligible": false
        },
        {
            "status": "SUCCESS",
 "description": "DMI Loan Service Provider",
            "payment_method": "DMI_LSP",
            "payment_method_type": "CONSUMER_FINANCE"
            "is_eligible": true
        }
    ]
}

```



| Key | Type | Description |
|---|---|---|
| payment_methods_eligibility | Array | Payment method (Lender in this case) level eligibility of user. |
| status | String | The Juspay mapped error status for the corresponding gateway error code. |
| payment_method_type | String | Type of the payment method like CONSUMER_FINANCE |
| payment_method | String | Name of the Payment Method (Lender in this case) which has eligibility criteria |
| is_eligible | Boolean | Payment method (Lender in this case) level eligibility of user |
| eligibility_strategy | String | Different strategy of eligibility like Transaction eligibility, User eligibility |
| description | String | Description about the payment method |


---

## See Also

- [Payment Methods API](https://juspay.io/in/docs/hyper-credit/web/hypercredit-checkout/payment-methods-api)
- [Create Order API](https://juspay.io/in/docs/hyper-credit/web/hypercredit-checkout/create-order-api)