Body
Check Eligibility API
Call eligibility API using the customer mobile number to check if the user is eligible for the transaction. This method can be invoked before the merchant opens their payment page and the UI can be handled upon the response of the eligibility of API call. Please note that it is a server-to-server authenticated call.
Request
Response
API Endpoints
Sandbox Link
POST
https://sandbox.juspay.in/v3/eligibility
Production Link
POST
https://api.juspay.in/v3/eligibility
Authorization Header
Basic Auth
*
Base64 Encoded Username-Password
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:-
MUQ2QUZEQzhFQTY0OUU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
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.
Warning
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
Request Schema: application/json
Basic Parameters
merchant_id
*
String
Mandatory
Merchant_id yes Merchant should pass the merchant_id
order_id
String
when eligibility is being called post order creation, order_id can be passed
amount
String
when eligibility is being called post order creation, amount can be passed
customer_id
String
Merchant can pass customer_id if available
gateway_reference_id
String
To be passed when merchant has configured multiple CRED gateway basis on their LOB
platform
*
String
Mandatory
Possible values: android, web, ios
os
*
String
Mandatory
Possible values: android, iOS, windows, linux, macOS, unknown
Please contact juspay team if you are facing any concern around it
device
*
String
Mandatory
Possible values: mobile, iPAD, desktop, tablet, unknown
Please contact juspay team if you are facing any concern around it
phoneNumber
*
RSA PKCS1 Encrypted
Mandatory
Must be encrypted using juspay public key
with RSA PKCS1 Encryption
Required to identify if the user is already a CRED registered user, Flow will be COLLECT in this case, otherwise the REDIRECT Flow.
credAppPresent
*
Boolean
Mandatory
Please refer to the set up page for more details.
200 : Success
Response Body
status
String
Merchant should show CRED on their payment page basis this key
Example:- Value: ELIGIBLE/INELIGIBLE
command_output.response .checkout_mode
String
This key will return the flow that will be triggered for the merchant.
intent:
collect: User will get a collect request on their CRED App
Web: Also known as redirect flow, user will be redirected to CRED page where he will be asked to sign up using a number and complete the transaction
layout.subtext
String
Offer text is present inside layout.subtext. Other fields are optional to be shown on UI.
400 : Invalid Input data
Response Body
Response- when encryption is incorrect
Object
status
String
BAD_REQUEST
error_code
String
HD_0009
error_description
String
User phone number is missing in request body
error_message
String
User phone number is missing in request body"
Have questions?
- Need help? Contact support
- LLM? Read llms.txt