📄️ Introduction
Splitit's Installments API is the primary Splitit tool for establishing and maintaining installment plans. Use it to verify shopper eligibility, create plans with or without immediate authorization, get plan
📄️ Get Splitit Token
To get a token, you will need your *client_id* and *client_secret* from your [Merchant Portal](https://merchant.sandbox.splitit.com). In your Merchant Portal, go to **Credentials** on the left-hand side. Find your **Username** (which is *client_id*) and generate or use an existing **Active Password** (which is *client_secret*).
📄️ Check Eligibility
As your customer begins to checkout, use this endpoint to verify their overall eligibility for Splitit installment plans and to determine plans for which they are eligible. This endpoint can be called repeatedly before and during checkout, for example you may call it after each field on a page is filled out. The Splitit API compares and updates the plan based on each new body as it arrives.
📄️ Create Installment Plan
Once you are ready to check your customer out, you can use the `Create` endpoint.
📄️ Initiate Installment Plan
Initiate establishes an installment plan but doesn't finalize it, and is thus intended for use
📄️ Verify Authorization
You must call Verify Authorization in cases when plan authorization and order closure do not happen simultaneously. An example of this would be when a customer checks out with a Payment Form or Flex Form, or is redirected for 3DS. To call it, you need to provide the plan number you received in the success response from [Initiate](/api/v3/initiate-installment-plan).
📄️ Fetch Plan by Number
Retrieve an installment plan's information by providing its number in your path.
📄️ Fetch Plan(s) by Alternate Field
Retrieves a plan by `RefOrderNumber` or `ExtendedParams`. Note that `RefOrderNumber` or `ExtendedParams` were optionally specified by you upon plan creation.
📄️ Update Plan by Number
Locate a plan by installment number then carry out post-authorization activities related to the plan, such as updating the order number, updating the tracking number, updating shipping status, or updating the plan amount (if it hasn't been captured yet). You can also use this endpoint to capture the first installment from a plan that has only been authorized but not yet captured.
📄️ Update Plan By Alternate Field
Locate a plan by `RefOrderNumber` or `ExtendedParams` then carry out post-authorization activities related to the plan, such as updating the order number, updating the tracking number, updating shipping status or updating the amount of the plan (if it hasn't been captured yet). You can also use this endpoint to capture the first installment from a plan that has only been authorized but not yet captured. Note that `RefOrderNumber` or `ExtendedParams` were optionally specified by you upon plan creation.
📄️ Refund a Plan
Refund part or all of an installment plan.
📄️ Errors List
Sort, filter and search for API v3 errors in the table below (click on header to sort and hamburger menu on right side of header for filters). You can also reorder columns by dragging and expand columns with |.