paze/paze-apimatic-sdk-sdk

SDKs for paze apis

1.0.0 2026-03-12 09:37 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

Paze Checkout API for Merchants

Install the Package

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

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

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

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

You can also view the package at: https://packagist.org/packages/paze/paze-apimatic-sdk-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.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
clientCredentialsAuth	ClientCredentialsAuth	The Credentials Setter for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

use PazeCheckoutAPILib\Environment;
use PazeCheckoutAPILib\Authentication\ClientCredentialsAuthCredentialsBuilder;
use PazeCheckoutAPILib\PazeCheckoutAPIClientBuilder;

$client = PazeCheckoutAPIClientBuilder::init()
    ->clientCredentialsAuthCredentials(
        ClientCredentialsAuthCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
    )
    ->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

Authorization

This API uses the following authentication schemes.

• OAuth2 (OAuth 2 Client Credentials Grant)

List of APIs

• Checkout Session
• Merchant Onboarding
• Identity

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• ApiException