Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Eligibility API

Determines if a customer has a linked wallet with sufficient amount for the order.

  Notes on Request Parameters:     (click to view)
Note:
1.
Either amount or the order_id should be present in the request so as to get the eligibility.
2.
gateway_data is gateway specific information, it can be mandatory for some gateways

Formats Supported:
      1. application/JSON
      2. application/x-www-form-urlencoded
  Response Parameters  for the Eligibility API:     (click to view)
ParameterTypeDescription
payment_methods_eligibility:
[{...},{...},..]
ArrayAn array of EligibilityData Objects. Lists all the payment methods which have eligibility criteria.
(see table below)
EligibilityData Object - provides details of each payment method of a customer.
FieldTypeDescription
payment_methodStringName of the Payment Method which has eligibility criteria
payment_method_typeStringType of the payment method, like WALLET
descriptionStringDescription about the payment method
is_eligibleBooleanFlag which specifies if the customer is eligible for the payment method
eligibility_strategyStringDifferent strategy of eligibility. like Transaction eligibility, User eligibility
balanceDoubleBalance given in the gateway eligibility response
statusStringThe Juspay mapped error status for the corresponding gateway error code
(see Appendix below)
due_dateStringDue date of the pay later option bill payment.
gateway_error_codeStringError code
gateway_error_messageStringError message given by gateway
  APPENDIX:   Eligibility status codes and meaning   (click to view)
Status codeDescription
SUCCESSSuccessful
INSUFFICIENT_FUNDSThe wallet amount is less than the order amount
USER_NOT_FOUNDUser not found for that gateway
BAD_REQUESTBad Request
INVALID_DATAInvalid header or input data or any of the values are expired
NOT_ACCESSIBLEWhen the user does not have access because of the insufficient credit limit or blocked to that wallet
PENDING_DUESPending dues are present in the wallet which user needs to clear
UNAUTHORIZEDUnauthorized
ERRORAny other error mapping
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!