README

Install the Package

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

composer require "apimatic-payrix-sdk/payrix-api-sdk-php:1.0.3"

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

"require": {
    "apimatic-payrix-sdk/payrix-api-sdk-php": "1.0.3"
}

You can also view the package at: https://packagist.org/packages/apimatic-payrix-sdk/payrix-api-sdk-php#1.0.3

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
apiKeyCredentials	`ApiKeyCredentials`	The Credentials Setter for Custom Header Signature
sessionKeyCredentials	`SessionKeyCredentials`	The Credentials Setter for Custom Header Signature
txnSessionKeyCredentials	`TxnSessionKeyCredentials`	The Credentials Setter for Custom Header Signature
usernameCredentials	`UsernameCredentials`	The Credentials Setter for Custom Header Signature
passwordCredentials	`PasswordCredentials`	The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

use PayrixLib\Environment;
use PayrixLib\Authentication\ApiKeyCredentialsBuilder;
use PayrixLib\Authentication\SessionKeyCredentialsBuilder;
use PayrixLib\Authentication\TxnSessionKeyCredentialsBuilder;
use PayrixLib\Authentication\UsernameCredentialsBuilder;
use PayrixLib\Authentication\PasswordCredentialsBuilder;
use PayrixLib\PayrixClientBuilder;

$client = PayrixClientBuilder::init()
    ->apiKeyCredentials(
        ApiKeyCredentialsBuilder::init(
            'APIKEY'
        )
    )
    ->sessionKeyCredentials(
        SessionKeyCredentialsBuilder::init(
            'SESSIONKEY'
        )
    )
    ->txnSessionKeyCredentials(
        TxnSessionKeyCredentialsBuilder::init(
            'TXNSESSIONKEY'
        )
    )
    ->usernameCredentials(
        UsernameCredentialsBuilder::init(
            'USERNAME'
        )
    )
    ->passwordCredentials(
        PasswordCredentialsBuilder::init(
            'PASSWORD'
        )
    )
    ->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
canada sandbox	-

apimatic-payrix-sdk / payrix-api-sdk-php

Maintainers

Details

README

Install the Package

Initialize the API Client

Environments

Fields

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities