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-payquicker/payquicker-sdk:1.0.1"

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

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

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

Test the SDK

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the require-dev dependencies.
2. 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:

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

Authorization

This API uses the following authentication schemes.

• server (OAuth 2 Client Credentials Grant)
• clientside (OAuth 2 Bearer token)

List of APIs

• Agreements
• Balances
• Bank Accounts
• Client Side
• Compliance
• Documents
• Electronic Wallets
• Events
• Invitations
• Jobs
• Payments
• Prepaid Cards
• Program
• Receipts
• Spendback
• Spendback Refunds
• Statements
• Transfers
• Users
• Webhooks

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• FileWrapper
• ApiException