README

Introduction

PayQuicker offers a secure and instant payout platform that delivers payment to a payee-owned and insured bank account linked to a debit card, similar to a standard checking account.

As soon as the payment is made, funds are available in the insured account and available to spend instantly online through a virtual card, at retail with a plastic prepaid debit card, or by loading the card to a mobile wallet.

PayQuicker provides a RESTful API that allows authorized clients to send and receive payments, debit user's accounts for spendback, retrieve user account balance, retrieve user reports, and retrieve transaction reports.

Install the Package

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

composer require "apimatic-pq/pq-api-matic-sdk:1.0.1"

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

"require": {
    "apimatic-pq/pq-api-matic-sdk": "1.0.1"
}

You can also view the package at: https://packagist.org/packages/apimatic-pq/pq-api-matic-sdk#1.0.1

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

First install the dependencies using composer including the require-dev dependencies.
Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

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
xMyPayQuickerVersion	`string`	Date-based API Version specified in the header required on all calls. Default: `'2026.02.01'`
sandboxInstance	`string(SandboxInstance)`	Sandbox Environments Default: `SandboxInstance::SANDBOX`
uatInstance	`string(UatInstance)`	UAT Environments Default: `UatInstance::UAT1`
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'`
loggingConfiguration	`LoggingConfigurationBuilder`	Represents the logging configurations for API calls
proxyConfiguration	`ProxyConfigurationBuilder`	Represents the proxy configurations for API calls
serverCredentials	`ServerCredentials`	The Credentials Setter for OAuth 2 Client Credentials Grant
clientsideCredentials	`ClientsideCredentials`	The Credentials Setter for OAuth 2 Bearer token

The API client can be initialized as follows:

use PayQuickerSDKLib\Logging\LoggingConfigurationBuilder;
use PayQuickerSDKLib\Logging\RequestLoggingConfigurationBuilder;
use PayQuickerSDKLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use PayQuickerSDKLib\Models\SandboxInstance;
use PayQuickerSDKLib\Models\UatInstance;
use PayQuickerSDKLib\Environment;
use PayQuickerSDKLib\Authentication\ServerCredentialsBuilder;
use PayQuickerSDKLib\Models\OAuthScopeServer;
use PayQuickerSDKLib\Authentication\ClientsideCredentialsBuilder;
use PayQuickerSDKLib\PayQuickerSDKClientBuilder;

$client = PayQuickerSDKClientBuilder::init()
    ->serverCredentials(
        ServerCredentialsBuilder::init(
            'OAuthClientId',
            'OAuthClientSecret'
        )
            ->oAuthScopes(
                [
                    OAuthScopeServer::READONLY,
                    OAuthScopeServer::MODIFY
                ]
            )
    )
    ->clientsideCredentials(
        ClientsideCredentialsBuilder::init(
            'AccessToken'
        )
    )
    ->xMyPayQuickerVersion('2026.02.01')
    ->environment(Environment::SANDBOX)
    ->sandboxInstance(SandboxInstance::SANDBOX)
    ->uatInstance(UatInstance::UAT1)
    ->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	Production
SANDBOX	Default Sandbox is used for both sandbox testing and customer UAT.
UAT	UAT is used for both sandbox testing and customer UAT.
DEVELOPMENT	Development is used for local development testing.

apimatic-pq / pq-api-matic-sdk

Maintainers

Details

README

Introduction

Install the Package

Test the SDK

Initialize the API Client

Environments

Fields

Authorization

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities