Skip to main content

Check Eligibility

POST 
/check-eligibility

As your customer begins to checkout, use this endpoint to verify their overall eligibility for Splitit installment plans and to determine plans for which they are eligible. This endpoint can be called repeatedly before and during checkout, for example you may call it after each field on a page is filled out. The Splitit API compares and updates the plan based on each new body as it arrives.

Request​

Header Parameters

    X-Splitit-IdempotencyKey string
    X-Splitit-Idempotency-Behaviour string

    Possible values: [DisableReprocessingOnError, AllowReprocessingOnError]

    AllowReprocessingOnError is the default, which means that if you have a failed response or a timeout, the original request is marked as having failed, but a new request can be sent using the same key and will be reprocessed; if you set it to DisableReprocessingOnError, a request with the same key will not be reprocessed after a failure, and if the key is used again, you will get the same error response you got the first time

Body

    PlanData

    object

    required

    TerminalIdstringrequired

    The merchant terminal identifier

    TotalAmountdecimalrequired

    The order total amount

    FirstInstallmentAmountdecimal
    Currencystringrequired
    NumberOfInstallmentsint32required
    PurchaseMethodstring

    How purchase was made (default is ECommerce)

    Possible values: [InStore, PhoneOrder, ECommerce]

    RefOrderNumberstring

    Reference order number for merchant's use

    AllowedInstallmentOptionsint32[]

    Tags

    object

    property name*string
    FirstInstallmentDatedate-time

    CardDetails

    object

    CardHolderFullNamestring
    CardNumberstring
    CardExpYearstring
    CardExpMonthstring
    CardCvvstring
    CardBrandstring

    Possible values: [Mastercard, Visa, AmericanExpress, Maestro, JCB, CUP, UPI, Discover, Other]

    CardTypestring

    Possible values: [Credit, Debit, Charge, Other, Prepaid, VisaDeferredDebit, NetworkOnly]

    BillingAddress

    object

    AddressLinestring
    AddressLine2string
    Citystring
    Countrystring

    ISO 3166 Country name OR 2-character code OR 3-character code

    Statestring

    ISO 3166-2 State

    Zipstring

Responses​

Success

Schema

    InstallmentProviderstring

    Either "Splitit" or "Visa"

    PaymentPlanOptions

    object[]

  • Array [

    • NumberOfInstallmentsint32required
    FirstInstallmentAmountdecimalrequired
    InstallmentAmountdecimalrequired
    LastInstallmentAmountdecimalrequired

    Links

    object

    PrivacyPolicyUrlstring
    TermsAndConditionsUrlstring
    LearnMoreUrlstring
    TermsAndConditionsBriefstring

    Terms and conditions text set by external provider

    InstallmentFrequencystring

    The interval of the installments, either monthly or biweekly

  • ]