API Client

Server SDK

API Client

Configure environments, timeouts, retries, logging, and proxy settings for the J-Pay Server SDK client.

Language

jpay-api/php-sdk

Client Class Documentation

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. <br> Default: Environment.PRODUCTION
timeout	int	Timeout for API calls in seconds.<br>Default: 30
enableRetries	bool	Whether to enable retries and backoff feature.<br>Default: false
numberOfRetries	int	The number of retries to make.<br>Default: 0
retryInterval	float	The retry time interval between the endpoint calls.<br>Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries.<br>Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests.<br>Default: 0
retryOnTimeout	bool	Whether to retry on request timeout.<br>Default: true
httpStatusCodesToRetry	array	Http status codes to retry against.<br>Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against.<br>Default: 'GET', 'PUT', 'GET', 'PUT'
loggingConfiguration	LoggingConfigurationBuilder	Represents the logging configurations for API calls
proxyConfiguration	ProxyConfigurationBuilder	Represents the proxy configurations for API calls
verifyPeer	bool	Whether to verify SSL certificates.<br>Default: true
verifyHost	bool	Whether to verify SSL host names.<br>Default: true

The API client can be initialized as follows:

use JPayApiLib\Logging\LoggingConfigurationBuilder;
use JPayApiLib\Logging\RequestLoggingConfigurationBuilder;
use JPayApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use JPayApiLib\Environment;
use JPayApiLib\JPayApiClientBuilder;

$client = JPayApiClientBuilder::init()
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

J-Pay API Client

The gateway for the SDK. This class acts as a factory for the Apis and also holds the configuration of the SDK.

Apis

Name	Description
getAgencyApi()	Gets AgencyApi
getFilesApi()	Gets FilesApi
getPaymentsApi()	Gets PaymentsApi
getPaymentsLinkPaymentApi()	Gets PaymentsLinkPaymentApi
getPayoutsApi()	Gets PayoutsApi