Getting Started with PQ API v2

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 from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Test the SDK

To validate the functionality of this SDK, you can execute all tests located in the test directory. This SDK utilizes Jest as both the testing framework and test runner.

To run the tests, navigate to the root directory of the SDK and execute the following command:

npm run test

Or you can also run tests with coverage report:

npm run test:coverage

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 | SandboxInstance | Sandbox EnvironmentsDefault: SandboxInstance.Sandbox | | uatInstance | UatInstance | UAT EnvironmentsDefault: UatInstance.Uat1 | | environment | Environment | The API environment. Default: Environment.Sandbox | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | logging | PartialLoggingOptions | Logging Configuration to enable logging | | serverCredentials | ServerCredentials | The credential object for server | | clientsideCredentials | ClientsideCredentials | The credential object for clientside |

The API client can be initialized as follows:

Code-Based Client Initialization

import {
  Client,
  Environment,
  LogLevel,
  OAuthScopeServer,
  SandboxInstance,
  UatInstance,
} from 'payquicker-apimatic-sdk';

const client = new Client({
  serverCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret',
    oAuthScopes: [
      OAuthScopeServer.Readonly,
      OAuthScopeServer.Modify
    ]
  },
  clientsideCredentials: {
    accessToken: 'AccessToken'
  },
  xMyPayQuickerVersion: '2026.02.01',
  timeout: 0,
  environment: Environment.Sandbox,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
  sandboxInstance: SandboxInstance.Sandbox,
  uatInstance: UatInstance.Uat1,
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'payquicker-apimatic-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'payquicker-apimatic-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

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. |

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

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError