Initiate Installment Plan

Initiate establishes an installment plan but doesn't finalize it, and is thus intended for use with Splitit premade checkout solutions such as Payment Forms or Flex Form. Initiate only requires SAQ-A certification. You can call it multiple times for the same installment plan, since each time a new API call is made, existing data will be updated and new values will be appended to the existing plan. Note that for funded plans, a customer's BillingAddress object must be filled out.

Header Parameters
X-Splitit-TestMode string
X-Splitit-IdempotencyKey string

Request Body
AutoCapture boolean — REQUIRED Indicates whether to capture the first installment automatically when creating the plan, or to wait for explicit indication to do the first capture (the default is true)
Attempt3dSecure boolean Indicates whether to run a 3D secure verification (default is false)
Shopper object FullName string Email string PhoneNumber string Culture string
PlanData object — REQUIRED TotalAmount decimal The total order amount Currency string — REQUIRED NumberOfInstallments int32 When populated will be used to display as default in Payment Form TerminalId string — REQUIRED The merchant terminal identifier PurchaseMethod string Possible values: [InStore, PhoneOrder, ECommerce] How purchase was made (default is ECommerce) RefOrderNumber string Reference order number for merchant's use ExtendedParams object Additional data that can be added as key/value pair parameters by merchant (and later can be retrieved by GET) FirstInstallmentAmount decimal FirstInstallmentDate date-time
BillingAddress object AddressLine1 string AddressLine2 string City string Country string ISO 3166-3 code State string ISO 3166-2 code Zip string
RedirectUrls object Used for 3DS redirection back to success or failure page Succeeded string Failed string Cancel string
UxSettings object DisplayedInstallmentOptions int32[]
EventsEndpoints object CreateSucceeded string

Responses
200 Success Schema — OPTIONAL InstallmentPlanNumber string — OPTIONAL RefOrderNumber string — OPTIONAL PurchaseMethod string — OPTIONAL Possible values: [InStore, PhoneOrder, ECommerce] How purchase was made (default is ECommerce) Status string Possible values: [Initialized, PendingCapture, Active, Cleared, Canceled] Currency string — OPTIONAL Amount decimal — OPTIONAL ExtendedParams object — OPTIONAL Shopper object — OPTIONAL FullName string — OPTIONAL Email string PhoneNumber string — OPTIONAL Culture string — OPTIONAL BillingAddress object — OPTIONAL AddressLine string — OPTIONAL AddressLine2 string — OPTIONAL City string — OPTIONAL Country string — OPTIONAL ISO 3166 Country name OR 2-character code OR 3-character code State string — OPTIONAL ISO 3166-2 State Zip string — OPTIONAL CheckoutUrl string — OPTIONAL
401 Unauthorized Request: 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: Plan or service 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-503 InvalidInstallmentPlanStatus: Please close this window. Then click 'Splitit Payment' to create your payment plan (you haven't been charged yet). Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-505 InvalidNumberOfInstallments: The number of installments is not available at this store. Please check available options and try again. Thank you! 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-524 InvalidEmailFormat: Invalid email. Please check that the email address is entered in the correct format. (For example: name@mail.com) Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-526 InvalidZIPCode: The ZIP code must include at least 3 characters. Please check and try again. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-528 InvalidCCIssueCountryNotSupportedByTerminal: We are sorry, but we currently do not accept cards issued by this country. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-529 CurrencyNotSupported: We are sorry, but we currently do not accept this currency. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-532 CountrySubdivisionNotSupported: Sorry, but Splitit is currently not available in your state. Please contact Splitit's customer service desk for help Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-550 CultureNameNotValid: Culture (language used in interfaces and communications) not valid. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-551 CultureNotSupported: Culture (language used in interfaces and communications) not supported. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-554 UnknownZipCode: The ZIP code you entered is not valid. Please try again. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-566 AddressDataIsMissingOrPartiallyInitiated: Please enter the cardholder's complete address. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-572 InvalidStateCode: We were unable to find this state code. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-575 CurrencyMustBeDefinedOnTransaction: Please select the currency you wish to use. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-595 PhoneIsMissing: Please enter your phone number. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-596 InvalidPhoneFormat: Please enter your phone number in this format: +1-321-555-1234. 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