PqApimaticSDK 1.0.3

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

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package PqApimaticSDK --version 1.0.3

You can also view the package at: https://www.nuget.org/packages/PqApimaticSDK/1.0.3

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:

Code-Based Initialization

using Microsoft.Extensions.Logging;
using PayQuickerSDK.Standard;
using PayQuickerSDK.Standard.Authentication;
using PayQuickerSDK.Standard.Models;
using System.Collections.Generic;

namespace ConsoleApp;

PayQuickerSDKClient client = new PayQuickerSDKClient.Builder()
    .ServerCredentials(
        new ServerModel.Builder(
            "OAuthClientId",
            "OAuthClientSecret"
        )
        .OAuthScopes(
            new List<OAuthScopeServer>
            {
                OAuthScopeServer.Readonly,
                OAuthScopeServer.Modify,
            })
        .Build())
    .ClientsideCredentials(
        new ClientsideModel.Builder(
            "AccessToken"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .XMyPayQuickerVersion("2026.02.01")
    .Environment(PayQuickerSDK.Standard.Environment.Sandbox)
    .SandboxInstance(SandboxInstance.Sandbox)
    .UatInstance(UatInstance.Uat1)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using PayQuickerSDK.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = PayQuickerSDKClient
    .FromConfiguration(configuration.GetSection("PayQuickerSDK"));

See the Configuration-Based Initialization section for details.

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

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter
• JsonObject
• JsonValue