splitit-apimatic/splitit-apimatic-sdk

SDK for Splitit webapi

1.0.0 2026-04-01 12:05 UTC

Requires

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

Requires (Dev)

• phan/phan: 5.4.5
• squizlabs/php_codesniffer: ^3.5

MIT

• Muhammad Rafay

README

Introduction

Splitit Orchestration API for managing installment plans.

Install the Package

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

composer require "splitit-apimatic/splitit-apimatic-sdk:1.0.0"

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

"require": {
    "splitit-apimatic/splitit-apimatic-sdk": "1.0.0"
}

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

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.SANDBOX
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
oAuth2Credentials	OAuth2Credentials	The Credentials Setter for OAuth 2 Client Credentials Grant
apiKeyCredentials	ApiKeyCredentials	The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

use SplititWebApiV4Lib\Environment;
use SplititWebApiV4Lib\Authentication\OAuth2CredentialsBuilder;
use SplititWebApiV4Lib\Models\OAuthScopeOAuth2Enum;
use SplititWebApiV4Lib\Authentication\ApiKeyCredentialsBuilder;
use SplititWebApiV4Lib\SplititWebApiV4ClientBuilder;

$client = SplititWebApiV4ClientBuilder::init()
    ->oAuth2Credentials(
        OAuth2CredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oAuthScopes(
                [
                    OAuthScopeOAuth2Enum::API_V4
                ]
            )
    )
    ->apiKeyCredentials(
        ApiKeyCredentialsBuilder::init(
            'X-Splitit-Api-Key'
        )
    )
    ->environment(Environment::SANDBOX)
    ->build();

Environments

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

Fields

Name	Description
SANDBOX	Default Sandbox Environment (Transactional API)
PRODUCTION	Production Environment (Transactional API)

Authorization

This API uses the following authentication schemes.

• OAuth2 (OAuth 2 Client Credentials Grant)
• ApiKey (Custom Header Signature)

List of APIs

• Installment Plan

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• ApiException