Skip to main content
Version: 4.0

Introduction

Splitit's Installments API version 4 is the primary Splitit tool for establishing and maintaining installment plans. Establishing a plan with v4 follows a simple flow with two steps:

  1. You query Splitit to get the plans that are available to your shopper, which are based on their location, their credit card's BIN, the amount they are spending, their currency, among other factors (Get Offers).
  2. Once your shopper agrees to a specific offer, you send an authorization to Splitit to establish the plan (Authorize).

API v4 also features tools that:

  • Check the validity of cards your shopper may have used with you previously or may be intending to use (Card Validity)
  • Redefine a chosen offer in case authorization failed or the shopper wants to change some details (Update Offers)
  • Generate a checkout link for your shopper to access a payment form instead of your handling checkout (Get Checkout Link)
  • Update an existing plan with new information such as shipping status (Update Orders)
  • Get information about an existing single plan or verify that it was successfully created (Get Installment Plans)
  • Search for information about multiple existing plans (Search Plans)
  • Refund or cancel a plan (Refund Plans)