---
page_source: https://juspay.io/in/docs/simpl-pay-in-3/docs/simpl-payin3/simpl-eligibility-payload
page_title: Simpl Eligibility Payload
---


# Check Simpl Pay-In-3 Eligibility 



This operation helps to determine whether the user is eligible to perform the transaction via Simpl pay-in-3 payment mode.

* The value "SIMPL_PAYINTHREE" should be passed in the checkType array of the `wallets` block and it is mandatory.
* The Simpl Pay-in-3 option verifies customer eligibility using their mobile number, which is retrieved from the number provided during customer creation or it can be passed in the eligibility SDK request payload.
  
  > **Note**
  > The Simpl payment option involves verifying customer eligibility, which requires specific parameters to be provided. For further information regarding these parameters, please reach out to the Simpl team. Sample parameters include first_txn_date, user_loyalty_level, etc.  
  
  
  
  
  ### Payload
  - **Payload**:
    - Value:
      - **Merchant_params**:
        - Value:
          - **Email**:
            - Description: The email address of the customer
            - Tags: String
          - **First_txn_date**:
            - Description: Date of first transaction customer has done with the merchant
            - Tags: String
          - **User_loyalty_level**:
            - Description: The loyalty level of the customer. Send "1" if the user falls in the primary category and "0" if they do not.
            - Tags: String
          - **User_blacklist_flag**:
            - Description: Indicates if a customer is part of a risky cohort. Send "1" if the user is risky, and "0" if not.
            - Tags: String
          - **Request_ori_page**:
            - Description: Indicates the origination of the Eligibility API call. Possible values: appopen, pdp, cart, checkout, retry, onclick, offer, walletlinking, subscription.
            - Tags: String
          - **Seller_identifier**:
            - Description: The unique identifier of the seller (applicable for marketplace or sub-merchant)
            - Tags: String
          - **Seller_vintage**:
            - Description: The number of months since the seller has been active on the parent merchant (applicable for marketplace or sub-merchant)
            - Tags: String
          - **Seller_category**:
            - Description: The category of the seller on the parent merchant (applicable for marketplace or sub-merchant scenarios)
            - Tags: String
          - **First_name**:
            - Description: The first name of the customer
            - Tags: String
          - **Billing_address**:
            - Description: The address linked to the payment mode used for the transaction Simpl identifies fraud clusters based on location. Fraudsters tend to create multiple accounts with the same address.
            - Tags: String
          - **Shipping_address**:
            - Description: The address where the purchased items will be delivered.
            - Tags: String
        - Tags: Json, Required
      - **Device_params**:
        - Description: Merchants do not need to manually send any `device_params` if the Simpl Fingerprint dependency is added to their apps, as it will automatically capture the device parameters.
        - Tags: String, Required
    - Tags: Json

## Sample Code Snippets:
### Eligibility:

#### Request Code Snippet:

```request
{
    "requestId": "0c4aa7ad-4574-b03a-31f0f8950671",
    "service": "in.juspay.hyperapi",
    "payload": {
        "action": "eligibility",
        "amount": "1.00",
        "clientAuthToken": "tkn_0e37edc631d64cfc4213",
        "orderId": "12345",
        "merchant_params": {
            "email": "shshh@gamil.com",
            "first_txn_date": "2019-07-17",
            "user_loyalty_level": "Gold",
            "user_blacklist_flag": "true",
            "request_ori_page": "precheckout",
            "seller_identifier": "123",
            "seller_vintage": "4",
            "seller_category": "PRIME",
            "additional_order_id": "12345",
            "first_name": "Simpl",
            "last_name": "Simpl",
            "aggregator_flow_ori": "headless"
        },
        "device_params": {
            "simpl_device_manufacturer": "Samsung",
            "simpl_device_model": "FT-129459",
            "simpl_isr": "false",
            "simpl_dres": "561,
570","simpl_duptime": "1100877165","simpl_can": "Walker, Dominguez and
Davis","simpl_ipa": "192.168. 1.1","simpl_pav": "testing","user_agent": "Mozilla/5.0
(Linux; Android 8.1.0; Redmi 5A Build/OPM1.171019.026; wv) AppleWebKit/537.36 (KHTML,
like Gecko) Version/4.0Chrome/97.0.4692.70 Mobile Safari/537.36","simpl_amem":
"2395",
            "simpl_adisk": "1666",
            "simpl_fontsize": "11",
            "simpl_pan": "6.6.4",
            "simpl_ltln": "-22.629812, -11.583188"
        },
        "data": {
            "consumerFinance": [
                {
                    "checkType": [
                        "SIMPL_PAYINTHREE"
                    ],
                    "customerId": "cust_test"
                }
            ],
            "cards": [],
            "wallets": [],
            "apps": []
        }
    }
}

```

### Response:

#### Eligible User - Simpl Pay-in-3:
```plaintext
{
    "service": "in.juspay.hyperapi",
    "requestId": "0c4aa7ad-4574-b03a-31f0f8950671",
    "payload": {
        "action": "eligibility",
        "wallets": [
            {
                "paymentMethodsEligibility": [
                    {
                        "status": "SUCCESS",
                        "paymentMethodType": "CONSUMER_FINANCE",
                        "paymentMethod": "SIMPL_PAYINTHREE",
                        "isEligible": true,
                        "installments": [
                            {
                                "tenure": 3,
                                "repaymentJourney": {
                                    "repaymentSchedule": [
                                        {
                                            "processingFee": "0.00",
                                            "date": "2024-09-06",
                                            "amount": "25.00"
                                        },
                                        {
                                            "processingFee": "0.00",
                                            "date": "2024-10-06",
                                            "amount": "25.00"
                                        },
                                        {
                                            "processingFee": "0.00",
                                            "date": "2024-11-06",
                                            "amount": "25.00"
                                        }
                                    ],
                                    "downPayment": {
                                        "processingFee": "0.00",
                                        "amount": "25.00"
                                    }
                                },
                                "installmentId": "d3e80ae425f04337ba1165d59992191d",
                                "gatewayPlanId": "19992",
                                "downPayment": "25.00",
                                "description": "Pay in 3"
                            }
                        ],
                        "description": "simpl"
                    }
                ],
                "orderId": "12345",
                "customerId": "9620226248"
            }
        ],
        "consumerFinance": [],
        "apps": [
            {
                "paymentMethodsEligibility": [],
                "orderId": "12345"
            }
        ]
    },
    "errorMessage": "",
    "errorCode": "",
    "error": false
}
```