# EligibilityApi All URIs are relative to *https://sandbox.cashfree.com/pg* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**pGEligibilityFetchCardlessEMI**](#pgeligibilityfetchcardlessemi) | **POST** /eligibility/cardlessemi | Get Eligible Cardless EMI Payment Methods for a customer on an order| |[**pGEligibilityFetchOffers**](#pgeligibilityfetchoffers) | **POST** /eligibility/offers | Get Eligible Offers for an Order| |[**pGEligibilityFetchPaylater**](#pgeligibilityfetchpaylater) | **POST** /eligibility/paylater | Get Eligible Paylater for a customer on an order| |[**pGEligibilityFetchPaymentMethods**](#pgeligibilityfetchpaymentmethods) | **POST** /eligibility/payment_methods | Get eligible Payment Methods| # **pGEligibilityFetchCardlessEMI** > Array pGEligibilityFetchCardlessEMI(EligibilityFetchCardlessEMIRequest) Use this API to get eligible Cardless EMI Payment Methods available for a customer on an order basis their phone number. ### Example ```typescript import { EligibilityApi, Configuration, EligibilityFetchCardlessEMIRequest } from 'cashfree-pg'; const configuration = new Configuration(); const apiInstance = new EligibilityApi(configuration); let x_api_version: string; //API version to be used. Format is in YYYY-MM-DD. (default to '2026-01-01') let EligibilityFetchCardlessEMIRequest: EligibilityFetchCardlessEMIRequest; //Request Body to get eligible cardless emi options for a customer and order. let x_request_id: string; //Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree. (optional) (default to undefined) let x_idempotency_key: string; //An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. (optional) (default to undefined) const { status, data } = await apiInstance.pGEligibilityFetchCardlessEMI( x_api_version, EligibilityFetchCardlessEMIRequest, x_request_id, x_idempotency_key ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **EligibilityFetchCardlessEMIRequest** | **EligibilityFetchCardlessEMIRequest**| Request Body to get eligible cardless emi options for a customer and order. | | | **x_api_version** | [**string**] | API version to be used. Format is in YYYY-MM-DD. | defaults to '2026-01-01'| | **x_request_id** | [**string**] | Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree. | (optional) defaults to undefined| | **x_idempotency_key** | [**string**] | An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. | (optional) defaults to undefined| ### Return type **Array** ### Authorization [XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**400** | Bad request error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**401** | Authentication Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**404** | Resource Not found. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**409** | Resource already present. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**422** | Idempotency error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**429** | Rate Limit Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**500** | API related Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**502** | Bank related Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **pGEligibilityFetchOffers** > Array pGEligibilityFetchOffers(EligibilityFetchOffersRequest) Use this API to get eligible offers for an order_id or order amount. ### Example ```typescript import { EligibilityApi, Configuration, EligibilityFetchOffersRequest } from 'cashfree-pg'; const configuration = new Configuration(); const apiInstance = new EligibilityApi(configuration); let x_api_version: string; //API version to be used. Format is in YYYY-MM-DD. (default to '2026-01-01') let EligibilityFetchOffersRequest: EligibilityFetchOffersRequest; //Request Body to get eligible offers for a customer and order. let x_request_id: string; //Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree. (optional) (default to undefined) let x_idempotency_key: string; //An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. (optional) (default to undefined) const { status, data } = await apiInstance.pGEligibilityFetchOffers( x_api_version, EligibilityFetchOffersRequest, x_request_id, x_idempotency_key ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **EligibilityFetchOffersRequest** | **EligibilityFetchOffersRequest**| Request Body to get eligible offers for a customer and order. | | | **x_api_version** | [**string**] | API version to be used. Format is in YYYY-MM-DD. | defaults to '2026-01-01'| | **x_request_id** | [**string**] | Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree. | (optional) defaults to undefined| | **x_idempotency_key** | [**string**] | An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. | (optional) defaults to undefined| ### Return type **Array** ### Authorization [XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**400** | Bad request error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**401** | Authentication Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**404** | Resource Not found. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**409** | Resource already present. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**422** | Idempotency error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**429** | Rate Limit Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**500** | API related Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **pGEligibilityFetchPaylater** > Array pGEligibilityFetchPaylater(EligibilityFetchPaylaterRequest) Use this API to get eligible Paylater Payment Methods for a customer on an order. ### Example ```typescript import { EligibilityApi, Configuration, EligibilityFetchPaylaterRequest } from 'cashfree-pg'; const configuration = new Configuration(); const apiInstance = new EligibilityApi(configuration); let x_api_version: string; //API version to be used. Format is in YYYY-MM-DD. (default to '2026-01-01') let EligibilityFetchPaylaterRequest: EligibilityFetchPaylaterRequest; //Request Body to get eligible paylater options for a customer and order. let x_request_id: string; //Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree. (optional) (default to undefined) let x_idempotency_key: string; //An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. (optional) (default to undefined) const { status, data } = await apiInstance.pGEligibilityFetchPaylater( x_api_version, EligibilityFetchPaylaterRequest, x_request_id, x_idempotency_key ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **EligibilityFetchPaylaterRequest** | **EligibilityFetchPaylaterRequest**| Request Body to get eligible paylater options for a customer and order. | | | **x_api_version** | [**string**] | API version to be used. Format is in YYYY-MM-DD. | defaults to '2026-01-01'| | **x_request_id** | [**string**] | Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree. | (optional) defaults to undefined| | **x_idempotency_key** | [**string**] | An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. | (optional) defaults to undefined| ### Return type **Array** ### Authorization [XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**400** | Bad request error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**401** | Authentication Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**404** | Resource Not found. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**409** | Resource already present. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**422** | Idempotency error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**429** | Rate Limit Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**500** | API related Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**502** | Bank related Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **pGEligibilityFetchPaymentMethods** > Array pGEligibilityFetchPaymentMethods(EligibilityFetchPaymentMethodsRequest) Use this API to get eligible Payment Methods. ### Example ```typescript import { EligibilityApi, Configuration, EligibilityFetchPaymentMethodsRequest } from 'cashfree-pg'; const configuration = new Configuration(); const apiInstance = new EligibilityApi(configuration); let x_api_version: string; //API version to be used. Format is in YYYY-MM-DD. (default to '2026-01-01') let EligibilityFetchPaymentMethodsRequest: EligibilityFetchPaymentMethodsRequest; //Request Body to get eligible payment methods for an account and order. let x_request_id: string; //Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree. (optional) (default to undefined) let x_idempotency_key: string; //An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. (optional) (default to undefined) let x_client_device: string; //The type of device on which the payment is initiated. (optional) (default to undefined) let x_client_os: string; //The operating system of the client device used to make the payment. (optional) (default to undefined) let x_client_rendering_type: string; //Indicates how the payment experience is rendered to the user. - mweb – Payment rendered in a mobile browser (browser on a mobile device) - webview – Payment rendered inside an in-app browser (WebView within a merchant app) - native – Payment rendered natively within the merchant’s mobile app using SDKs. (optional) (default to undefined) let x_client_browser: string; //The browser used to initiate the payment. (optional) (default to undefined) const { status, data } = await apiInstance.pGEligibilityFetchPaymentMethods( x_api_version, EligibilityFetchPaymentMethodsRequest, x_request_id, x_idempotency_key, x_client_device, x_client_os, x_client_rendering_type, x_client_browser ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **EligibilityFetchPaymentMethodsRequest** | **EligibilityFetchPaymentMethodsRequest**| Request Body to get eligible payment methods for an account and order. | | | **x_api_version** | [**string**] | API version to be used. Format is in YYYY-MM-DD. | defaults to '2026-01-01'| | **x_request_id** | [**string**] | Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree. | (optional) defaults to undefined| | **x_idempotency_key** | [**string**] | An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions. | (optional) defaults to undefined| | **x_client_device** | [**string**] | The type of device on which the payment is initiated. | (optional) defaults to undefined| | **x_client_os** | [**string**] | The operating system of the client device used to make the payment. | (optional) defaults to undefined| | **x_client_rendering_type** | [**string**] | Indicates how the payment experience is rendered to the user. - mweb – Payment rendered in a mobile browser (browser on a mobile device) - webview – Payment rendered inside an in-app browser (WebView within a merchant app) - native – Payment rendered natively within the merchant’s mobile app using SDKs. | (optional) defaults to undefined| | **x_client_browser** | [**string**] | The browser used to initiate the payment. | (optional) defaults to undefined| ### Return type **Array** ### Authorization [XPartnerAPIKey](../README.md#XPartnerAPIKey), [XClientSecret](../README.md#XClientSecret), [XPartnerMerchantID](../README.md#XPartnerMerchantID), [XClientID](../README.md#XClientID), [XClientSignatureHeader](../README.md#XClientSignatureHeader) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | OK | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**400** | Bad request error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**401** | Authentication Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**404** | Resource Not found. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**409** | Resource already present. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**422** | Idempotency error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**429** | Rate Limit Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**500** | API related Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| |**502** | Bank related Error. | * x-api-version -
* x-ratelimit-limit -
* x-ratelimit-remaining -
* x-ratelimit-retry -
* x-ratelimit-type -
* x-request-id -
* x-idempotency-key -
* x-idempotency-replayed -
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)