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.

Header Parameters
X-Splitit-IdempotencyKey string

Request Body
PlanData object — REQUIRED TerminalId string — REQUIRED The merchant terminal identifier TotalAmount decimal — REQUIRED The order total amount FirstInstallmentAmount decimal Currency string — REQUIRED NumberOfInstallments int32 — REQUIRED 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 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
200 Success Schema — OPTIONAL PaymentPlanOptions object[] — OPTIONAL NumberOfInstallments int32 FirstInstallmentAmount decimal InstallmentAmount decimal LastInstallmentAmount decimal Links object — OPTIONAL PrivacyPolicyUrl string — OPTIONAL TermsAndConditionsUrl string — OPTIONAL LearnMoreUrl string — OPTIONAL
401 Token is not authorized or is expired Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
403 Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
404 Resource Does Not Exist: For all APIs, if an invalid plan number is passed in the URL, this error will be returned Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
500 General Server Error : Server encountered an unexpected condition Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-511 InvalidAmount: Invalid amount sent, such as below your minimum amount or above your maximum amount. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-542 InvalidCCCardBrandNotSupported: Sorry but we do not accept this type of credit card. Please use {{SupportedCardBrands}} to complete your purchase. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-563 InvalidCurrency_NotSupportedByTerminal: Sorry, but this currency is not currently accepted at this terminal. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-564 CreditCardIsMissing: Some information is missing. Please enter all requested credit card details. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-599 General Error: Sorry. There has been an error. Please try again. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-806 TerminalApiKeyMissing: Terminal ID not found. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL