splitit/splitit-sdk-sdk

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 information, update plan status, and process refunds and cancellations.

0.0.62 2025-07-01 14:27 UTC

Requires

• php: ^7.2 || ^8.0
• ext-curl: *
• ext-json: *
• apimatic/core: ~0.3.13
• apimatic/core-interfaces: ~0.1.5
• apimatic/unirest-php: ^4.0.6

Requires (Dev)

• phan/phan: 5.4.5
• phpunit/phpunit: ^7.5 || ^8.5 || ^9.5
• squizlabs/php_codesniffer: ^3.5

MIT

• Erel Lindzen

• payments
• sdk
• api v3
• installments
• splitit

README

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "splitit/splitit-sdk-sdk:0.0.47"

Or add it to the composer.json file manually as given below:

"require": {
    "splitit/splitit-sdk-sdk": "0.0.47"
}

You can also view the package at: https://packagist.org/packages/splitit/splitit-sdk-sdk#0.0.47

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the require-dev dependencies.
2. Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. Default: Environment.PRODUCTION
timeout	int	Timeout for API calls in seconds. Default: 0
enableRetries	bool	Whether to enable retries and backoff feature. Default: false
numberOfRetries	int	The number of retries to make. Default: 0
retryInterval	float	The retry time interval between the endpoint calls. Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries. Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests. Default: 0
retryOnTimeout	bool	Whether to retry on request timeout. Default: true
httpStatusCodesToRetry	array	Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against. Default: 'GET', 'PUT'
proxyConfiguration	ProxyConfigurationBuilder	Represents the proxy configurations for API calls
oAuth2SandboxCredentials	OAuth2SandboxCredentials	The Credentials Setter for OAuth 2 Client Credentials Grant
oAuth2ProductionCredentials	OAuth2ProductionCredentials	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

use SplititWebApiV3Lib\Environment;
use SplititWebApiV3Lib\Authentication\OAuth2SandboxCredentialsBuilder;
use SplititWebApiV3Lib\Models\OAuthScopeOAuth2SandboxEnum;
use SplititWebApiV3Lib\Authentication\OAuth2ProductionCredentialsBuilder;
use SplititWebApiV3Lib\Models\OAuthScopeOAuth2ProductionEnum;
use SplititWebApiV3Lib\SplititWebApiV3ClientBuilder;

$client = SplititWebApiV3ClientBuilder::init()
    ->oAuth2SandboxCredentials(
        OAuth2SandboxCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oAuthScopes(
                [
                    OAuthScopeOAuth2SandboxEnum::API_V3
                ]
            )
    )
    ->oAuth2ProductionCredentials(
        OAuth2ProductionCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oAuthScopes(
                [
                    OAuthScopeOAuth2ProductionEnum::API_V3
                ]
            )
    )
    ->environment(Environment::PRODUCTION)
    ->build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
production	Default Sandbox
environment2	Production

Authorization

This API uses the following authentication schemes.

• OAuth2-sandbox (OAuth 2 Client Credentials Grant)
• OAuth2-production (OAuth 2 Client Credentials Grant)

List of APIs

• Installment Plan

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• ApiException