README

Introduction

POLi provides the POLi API consisting of the following web services:
Initiate Transaction -used to initiate a POLi transaction.

GETTransaction - used to acquire the status and details of a POLi transaction

GETDailyTransactions - used to acquire a list of transactions for a specified date

GETDailyTransactionsCSV - used to acquire a list of transactions for a specified date in csv format

GETFinancialInstitutions - used to acquire a list of Financial Institutions for a specified merchant

NOTE: The Notification URL field in your initiate transaction request must be provided. The POLi system will POST a 'NUDGE' to the specified notification URL and this will prompt your servers to make the GETTransaction API call.

Install the Package

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

composer require "sdksio/apimatic-polpay-sdk:0.0.1"

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

"require": {
    "sdksio/apimatic-polpay-sdk": "0.0.1"
}

You can also view the package at: https://packagist.org/packages/sdksio/apimatic-polpay-sdk#0.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
environment	`Environment`	The API environment. Default: `Environment.PRODUCTION`
timeout	`int`	Timeout for API calls in seconds. Default: `30`
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
basicAuthCredentials	`BasicAuthCredentials`	The Credentials Setter for Basic Authentication

The API client can be initialized as follows:

use PoliApIsLib\Logging\LoggingConfigurationBuilder;
use PoliApIsLib\Logging\RequestLoggingConfigurationBuilder;
use PoliApIsLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use PoliApIsLib\Environment;
use PoliApIsLib\Authentication\BasicAuthCredentialsBuilder;
use PoliApIsLib\PoliApIsClientBuilder;

$client = PoliApIsClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'BasicAuthUserName',
            'BasicAuthPassword'
        )
    )
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

Environments

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

Fields

Name	Description
PRODUCTION	Default Production environment
ENVIRONMENT2	UAT environment

sdksio / apimatic-polpay-sdk

Maintainers

Details

README

Introduction

Install the Package

Initialize the API Client

Environments

Fields

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities