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

    TerminalId stringrequired

    The merchant terminal identifier

    TotalAmount decimalrequired

    The order total amount

    FirstInstallmentAmount decimal
    Currency stringrequired
    NumberOfInstallments int32required
    PurchaseMethod string

    Possible values: [InStore, PhoneOrder, ECommerce]

    How purchase was made (default is ECommerce)

    RefOrderNumber string

    Reference order number for merchant's use

    AllowedInstallmentOptions int32[]

    Tags

    object

    property name* string
    FirstInstallmentDate date-time

    CardDetails

    object

    CardHolderFullName string
    CardNumber string
    CardExpYear string
    CardExpMonth string
    CardCvv string
    CardBrand string

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

    CardType string

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

    BillingAddress

    object

    AddressLine string
    AddressLine2 string
    City string
    Country string

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

    State string

    ISO 3166-2 State

    Zip string

Responses​

Success

Schema

    InstallmentProvider string

    Either "Splitit" or "Visa"

    PaymentPlanOptions

    object[]

  • Array [

    • NumberOfInstallments int32required
    FirstInstallmentAmount decimalrequired
    InstallmentAmount decimalrequired
    LastInstallmentAmount decimalrequired

    Links

    object

    PrivacyPolicyUrl string
    TermsAndConditionsUrl string
    LearnMoreUrl string
    TermsAndConditionsBrief string

    Terms and conditions text set by external provider

    InstallmentFrequency string

    The interval of the installments, either monthly or biweekly

  • ]

Loading...