For Developers

Hosted Solution

Transaction Flow

We have built our Hosted solution for merchants looking for an easy and fast integration, without taking the liability and responsibility of credit card insertion (yes, this solution will keep you out of PCI compliance scope)! This means that as soon as the shopper has chosen to pay with Splitit on your checkout, you will be able to redirect him to Splitit pages.

It will look like this:


Before starting the Hosted solution API implementation, make sure to read our API Documentation Introduction and continue with the following workflow:

First, in order to connect to our services, you will need to authenticate yourself and get sessionID, click here for more information regarding the login service.

Important Notice – You should never expose authentication data or a session ID to the client side.  The login call should only be initiated on your server side.

Request Response (Partial response displayed)


2.Initiate Installment Plan

Call Initiate Service (from server side) with the SessionId, order details (amount, shopper information, billing address) and exits URLs  – SuccessURL and CancelURL.
The service response will return checkout URL that you will be able to use in order to open Splitit payment wizard, click here for more information regarding the initiate service.

Request Response (Partial response displayed)





3.Redirect from merchant checkout to Splitit’s payment form

With the checkout URL that is received from a previous response, you will be able to redirect the shopper to the Splitit payment wizard in order to complete the payment.

Optional – In order to provide a better shopping experience, you can instead open the payment form as a floating iframe overlay to your website.  To support this, you should paste the following code to your client side:

In header, add following code:

<script id=”splitit-form-loader” src=”[URL]/js/payment-form-loader.js”></script>


Remark – URL:

For production use

For sandbox use

In body, add following code:

                        <button onclick=”loadSplititPaymentForm([checkoutURL]’)”>Open Splitit IFrame</button>
               <div id=”splitit-payment-form” class=”iframe-container”></div>

Remark: checkoutURL – The url that was returned from the initiate call

4.Redirect back from the Splitit payment form to the merchant checkout and closing the order 

After a payment is completed (or canceled by the shopper), the shopper will be redirected back to the exit URLs defined in the previous call (SuccessURL or CancelURL). The redirect URL will also include the unique installment plan number and your order reference number that will help you to close the order on your side.

  1. Remarks:
    • Before you close the order on your side, it is highly recommended that you run a VerifyPayment request to the Splitit server in order to verify that the payment was done on Splitit successfully (see more details here). This step is required in order to prevent unauthorized or faked success URLs and to prevent false order closed notification without the payment actually being completed on the Splitit server.
    • To prevent rare cases where the order was paid via the Splitit payment form but the redirection failed (ex: network problem or merchant server temporary downtime), it is also recommended to set the CreateSucceeded property (in EventsEndpoints ) with URL as part of the initiate request (see previous step). This URL will be called asynchronously from Splitit server after the plan was created successfully to make sure that the caller was notified that the plan was created.
    • In case you decided to open the payment form as floating iframe (see previous section), it’s not mandatory to populate the canceled redirect URL as part of the initiate call, in that case, the payment form will be closed with no redirection when clicking cancel on the payment form.
  2. (Optional) Start installment:
    In case you have decided not to capture your first installment automatically on creation but wait with the first charge to the time of shipping (can be done by setting the AutoCapture to false while initializing the plan), you will need to call the start installments service, this request will trigger the installment plan first charge. Click here for more information regarding the start installment service.


You are done!
The plan was created and the first installment was charged.

Interested in Splitit?

Leave your details so we can be in touch

Thank you for contacting us

We appreciate your interest and will be in touch shortly