Payment Form Redirect

Splitit's Hosted Payment Solution (Payment Form Redirect) features a full redirect from your site to Splitit's. To use it, you fetch a URL from the Splitit API then send your customer there to enter credit card data. After the customer is done checking out, they are sent back to URLs of your choice, which you specify in the initial API call (success, cancel, or failure).


The easiest way to experiment with the Payment Form Redirect quickly is by using our Quick Start guide, which takes you step by step, from obtaining your API credentials to fetching the Splitit URL. Make sure to review the sections below before going into production, however, as there are additional security considerations to consider.


Your first API call to Splitit should be to Login to retrieve a SessionId. This SessionId is used for subsequent calls and is valid for 20 minutes after your last successful API call. You can read more details about Login in the API Reference.

Initiate an Installment Plan

The Initiate API call requires specific details such as SessionId, order details (capture strategy, amount, shopper information, billing address—mandatory for funded plans) and return URLs (success, cancel, or failure) so that the customer can be redirected back to your site once they have completed the payment form. You can learn more about Initiate in the API Reference.

Redirect to Splitit

After receiving a successful Initiate response, the parameter CheckoutUrl is returned, which contains a unique one-time URL. This URL is valid for one hour (but can be extended on request). It redirects the customer to the Splitit Hosted Payment Solution to complete payment.

Redirect Back from Splitit

Splitit will redirect the customer back to one of the three provided URLs, depending on the outcome of the transaction. The redirect URL includes querystring values for Installment Plan Number and Reference Order Number, which will help you process the order.
Before completing the order, it is recommended that you call VerifyPayment in order to verify that the payment was successful. This prevents unauthorized or faked success URLs and prevents false “order closed” notifications without the payment actually being completed on the Splitit servers.
In rare cases, an order will be successfully paid for using the Splitit payment form but redirection fails (for example if there is a network problem or merchant server temporary downtime). To combat this, it is recommended that you set the CreateSucceeded property (under the EventsEndpoints object of the Initiate call) with a dedicated URL. This URL is a webhook that is called asynchronously from the Splitit server after the plan has been created successfully. By doing this, you can confirm that payment was successful even if redirection fails.
If you have decided not to capture the first installment automatically on the creation of the installment plan, you have the option to hold the first charge until a later date (must be within three weeks). This is done by setting AutoCapture to false in the Initiate call. You will need to call StartInstallments when you are ready to start the first installment. This request will trigger the first charge.
Last modified 3mo ago