JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Eligibility API

The API is used to check if the customer is eligible for the pay later options. The API would return the list of all the pay later options that is configured in your account. It is a sync API, ie when merchants call the eligibility API Juspay checks the eligibility with the respective wallets and return the response. Hence the latency of the API can be comparatively higher.

Either amount or the order_id should be present in the request so as to get the eligibility.
gateway_data is gateway specific information, it can be mandatory for some
gateways

Format Supported:

application/JSON
application/x-www-form-urlencoded

Status and description:

Scroll inside to view more

Status	Description
SUCCESS	Successful
USER_NOT_FOUND	User not found for that gateway
BAD_REQUEST	Bad Request
INVALID_DATA	Invalid header or input data or any of the values are expired
NOT_ACCESSIBLE	When the user does not have access because of the insufficient credit limit or blocked to that wallet
PENDING_DUES	Pending dues are present in the wallet which user needs to clear
UNAUTHORIZED	Unauthorized
ERROR	Any other error mapping

Error Code And Description

Scroll inside to view more

Error Code	Description
linking_required	Link the Simpl account
pending_bill	Clear the previous dues to proceed
insufficient_credit	Clear the previous dues to proceed
unable_to_process	Transaction Amount exceeds spending limit
user_unauthorized	User is not eligible to use Simpl

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/customers/{customer_id}/eligibility

Production Link

POST

https://api.juspay.in/customers/{customer_id}/eligibility

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      Content-Type
                      *
                      

String

Mandatory

application/x-www-form-urlencoded

                      x-routing-id
                      *
                      

String

Required

We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.

This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.

Example:- customer_1122

                      customer_id
                      *
                      

String

Mandatory

Customer Id for which you want to check the eligibility

Body

                      amount
                      
                      

string

Conditional

Amount to check eligibility. Conditional (either order_id or amount are required)

                      order_id
                      
                      

string

Conditional

Order id to check eligibility. Conditional (either order_id or amount are required)

                      gateway_data
                      
                      

string

Details required for the gateway call.

                      gateway_reference_id
                      
                      

string

Reference Id configured in case of multi MID setup.

                      mobile_number
                      
                      

string

Mobile number to check eligibility. (Conditional, required if customer id is not created with Juspay)

Response Body

                      Success Response
                      
                      

JSON

                      payment_methods_eligibility	
                      
                      

Array of Objects

Lists all the payment methods which has eligibility criteria

                      status
                      
                      

String

The Juspay mapped error status for the corresponding gateway error code.

                      payment_method_type
                      
                      

String

Type of the payment method like WALLET

                      payment_method
                      
                      

String

Name of the Payment Method which has eligibility criteria

                      is_eligible
                      
                      

Boolean

Flag which specifies if the customer is eligible for the payment method

                      eligibility_strategy
                      
                      

String

Different strategy of eligibility like Transaction eligibility, User eligibility

                      due_date
                      
                      

String

Due date of the pay later option bill payment.

                      description
                      
                      

String

Description about the payment method

                      Error Response
                      
                      

JSON

                      payment_methods_eligibility
                      
                      

String

Lists all the payment methods
which has eligibility criteria

                      status
                      
                      

String

The Juspay mapped error status for the corresponding gateway error code.

                      payment_method_type
                      
                      

String

Type of the payment method like WALLET

                      payment_method
                      
                      

String

Name of the Payment Method which has eligibility criteria

                      is_eligible
                      
                      

Boolean

Flag which specifies if the customer is eligible for the payment method

                      gateway_error_code
                      
                      

String

Error code

                      gateway_error_message
                      
                      

String

Error message given by gateway

                      description
                      
                      

String

Description about the payment method

Response Body

                      status
                      
                      

string

Invalid Request

                      error_message
                      
                      

string

Request should contain either amount or order id

                      error_code
                      
                      

string

Request should contain either amount or order id

Have questions?
Need help? Contact support
LLM? Read llms.txt