Eligibility API

Request

📘

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

Format Supported:

  1. application/JSON
  2. application/x-www-form-urlencoded

Response

FiledTypeDescription
payment_methods_eligibilityArrayLists all the payment methods
which has eligibility criteria

EligibilityData

FiledTypeDescription
payment_methodStringName o f 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.
due_dateStringDue date of the pay later option
bill payment.
gateway_error_codeStringError code
gateway_error_messageStringError message given by gateway

Status and description:

StatusDescription
SUCCESSSuccessful
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

Error Code And Description

Error CodeDescription
linking_requiredLink the Simpl account
pending_billClear the previous dues to proceed
insufficient_creditClear the previous dues to proceed
unable_to_processTransaction Amount exceeds spending limit
user_unauthorizedUser is not eligible to use Simpl
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!