Initiate Installment Plan
POST/initiate
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.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 500
- 400-503
- 400-505
- 400-511
- 400-524
- 400-526
- 400-528
- 400-529
- 400-532
- 400-550
- 400-551
- 400-554
- 400-566
- 400-572
- 400-575
- 400-595
- 400-596
- 400-599
- 400-806
Success
Unauthorized Request: Token is not authorized or is expired
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
General Server Error: Server encountered an unexpected condition
InvalidInstallmentPlanStatus: Please close this window. Then click 'Splitit Payment' to create your payment plan (you haven't been charged yet).
InvalidNumberOfInstallments: The number of installments is not available at this store. Please check available options and try again. Thank you!
InvalidAmount: Invalid amount sent, such as below your minimum amount or above your maximum amount.
InvalidEmailFormat: Invalid email. Please check that the email address is entered in the correct format. (For example: name@mail.com)
InvalidZIPCode: The ZIP code must include at least 3 characters. Please check and try again.
InvalidCCIssueCountryNotSupportedByTerminal: We are sorry, but we currently do not accept cards issued by this country.
CurrencyNotSupported: We are sorry, but we currently do not accept this currency.
CountrySubdivisionNotSupported: Sorry, but Splitit is currently not available in your state. Please contact Splitit's customer service desk for help
CultureNameNotValid: Culture (language used in interfaces and communications) not valid.
CultureNotSupported: Culture (language used in interfaces and communications) not supported.
UnknownZipCode: The ZIP code you entered is not valid. Please try again.
AddressDataIsMissingOrPartiallyInitiated: Please enter the cardholder's complete address.
InvalidStateCode: We were unable to find this state code.
CurrencyMustBeDefinedOnTransaction: Please select the currency you wish to use.
PhoneIsMissing: Please enter your phone number.
InvalidPhoneFormat: Please enter your phone number in this format: +1-321-555-1234.
General Error: Sorry. There has been an error. Please try again.
TerminalApiKeyMissing: Terminal ID not found.