Renew Installment Plan
POST/:relyInstallmentPlanNumber/renew
Start a new plan using the parameters of a previous plan, including payment method, by passing the original plan's installment number to the Renew Installment Plan endpoint. All fields, apart from TerminalId (in the PlanData object), are optional, because all data from the original plan gets carried over.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 500
- 200-641
- 400-503
- 400-504
- 400-505
- 400-510
- 400-511
- 400-520
- 400-521
- 400-522
- 400-524
- 400-526
- 400-528
- 400-529
- 400-532
- 400-540
- 400-542
- 400-543
- 400-544
- 400-550
- 400-551
- 400-554
- 400-566
- 400-567
- 400-568
- 400-569
- 400-570
- 400-571
- 400-572
- 400-573
- 400-574
- 400-575
- 400-578
- 400-580
- 400-594
- 400-595
- 400-596
- 400-599
- 400-600
- 400-601
- 400-602
- 400-603
- 400-606
- 400-607
- 400-608
- 400-609
- 400-610
- 400-630
- 400-640
- 400-643
- 400-644
- 400-806
- 400-1041
- 400-5041
- 400-5042
- 400-5421
- 400-5422
- 400-5801
- 400-5802
- 400-5911
- 400-5982
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
Including in the 200 response object's Authorization object under SplititErrorResultCode, it indicates that you need to redirect your shopper to ClientRedirectUrl for 3DS (also in the Authorization object); message: Gtwy3DSRequired: 3D secure verification is required. Refer to https://developers.splitit.com/direct-api/api-add-ons/white-label-3ds for more information.
InvalidInstallmentPlanStatus: Please close this window. Then click 'Splitit Payment' to create your payment plan (you haven't been charged yet).
InvalidCCCardTypeNotSupported: Sorry, but we do not accept debit cards. We can only accept Visa and MasterCard credit cards at this time.
InvalidNumberOfInstallments: The number of installments is not available at this store. Please check available options and try again. Thank you!
InvalidCardholderName: The cardholder name must include at least 3 characters. Please check and try again
InvalidAmount: Invalid amount sent, such as below your minimum amount or above your maximum amount.
InvalidCVV: The CVV number must include at least 3 characters. Please check and try again.
InvalidCardNumber: This credit card number is not valid. Please check your card and try again.
InvalidExpirationDate: The entered expiration date is not a valid date. Please check your card and try again.
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
InvalidExpirationDateFormat: Please enter the expiration date as MM/DD/YYYY.
InvalidCCCardBrandNotSupported: Sorry but we do not accept this type of credit card. Please use [[SupportedCardBrands]] to complete your purchase.
ApprovePlan_NoApprovalEvidence: Evidence of customer approval not provided.
PlanWithTheSamePaymentDataAlreadyBeenCreatedLately: A similar purchase has been processed with this credit card. Please contact your merchant's customer support number for more information.
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.
CardHolderNameIsMissing: Please enter the cardholder's name.
CardNumberIsMissing: Please enter the full credit card number.
CardExpirationMonthIsMissing: Please enter the credit card's expiration month.
CardExpirationYearIsMissing: Please insert credit card's expiration year.
NumberOfInstallmentNotDefined: Please select the number of installments for this purchase.
InvalidStateCode: We were unable to find this state code.
EmailsMissing: Please enter your email address.
ConsumerFullNameIsMissing: Please enter your full name.
CurrencyMustBeDefinedOnTransaction: Please select the currency you wish to use.
InvalidPlanStrategy: We are sorry for the inconvenience, but this plan is not available.
InvalidCcPrepaidCardNotSupported: We do not currently accept prepaid cards, but we do accept credit cards.
FraudDetected: Sorry, but we were unable to process your payment. Please reach out to our customer support team at support@splitit.com.
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.
GtwyResultGeneralError: Gateway was unable to process this request. Please try using a different card.
GtwyResultCCDataAVSZip: The ZIP code you entered is not valid. Please try again.
GtwyResultCCDataAVSAddress: The address does not match. Please check your card and try again.
GtwyResultCCDataCVV: The CVV number does not match. Please check your card and try again.
GtwyResultCCDataAVS: Address or zip/post code failed validation. Please try again.
GtwyResultCCDataNumber: This credit card number is not valid. Please check your card and try again.
GtwyResultCCDataGeneralProblem: Sorry, but your card was not able to be processed. Please try a different card.
GtwyResultCCDataInsufficientFunds: Sorry, but there is not enough available credit on this card to cover the full amount of your purchase. Please try a different card.
GtwyResultCCWasDeclined: Sorry, but your card was not accepted. Please try a different card.
GtwyConnectivityProblem: Sorry, but there was an error processing your payment. Please try again.
GtwyMerchantDataProblem: Sorry, but there has been a processing error with this merchant. Please contact our support for assistance.
Gtwy3DAuthenticationFailed: 3DS authentication against the issuer failed.
GtwyFraudDetected: Transaction was suspected to be fraudulent by the GW.
TerminalApiKeyMissing: Terminal ID not found.
IdempotencyHashMismatchError: Same Idempotency key with different payload identified.
InvalidCCCardTypeNotSupportedMoreThanXInstallments: [[CardType]] cards support only up to [[MaxInstallmentsLimit]] installments. Please reduce the number of installments or provide payment details for a supported credit card.
InvalidCCCardTypeNotSupportedMoreThanXAmount: [[CardType]] cards are only supported for purchases up to [[Currency]][[MaxPlanAmount]]. Please provide payment details for a credit card in order to support your total purchase amount.
InvalidCCCardBrandNotSupportedMoreThanXInstallments: [[CardBrand]] cards are supported only up to [[MaxInstallmentsLimit]] installments. Please reduce the number of installments or provide payment details for a supported credit card.
InvalidCCCardBrandNotSupportedMoreThanXAmount: [[CardBrand]] cards are only supported for purchases up to [[Currency]][[MaxPlanAmount]]. Please try a different card.
InvalidCcPrepaidCardNotSupportedMoreThanXInstallments: [[CardType]] cards allow a maximum of [[MaxInstallmentsLimit]] installments. Please choose fewer installments or try a different credit card.
InvalidCcPrepaidCardNotSupportedMoreThanXAmount: The maximum purchase for [[CardType]] cards is [[Currency]][[MaxPlanAmount]]. Please try a different card.
PlanContextNotValidForAmount: Purchase is only supported for up to [[Currency]][[MaxPlanAmount]]. Please provide payment details for a credit card in order to support your total purchase amount.
PlanContextNotValidForAmount: Purchase is only supported for up to [[Currency]][[MaxPlanAmount]]. Please provide payment details for a credit card in order to support your total purchase amount.