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:

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

Authorization

This API uses the following authentication schemes.

• Basic (Basic Authentication)

List of APIs

• Payments API
• PoLi Links API

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse