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
The package is compatible with Python versions 3.7+.
Install the package from PyPi using the following pip command:
pip install payquicker-api-sdk==1.0.0
You can also view the package at: https://pypi.python.org/pypi/payquicker-api-sdk/1.0.0
Test the SDK
You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:
Navigate to the root directory of the SDK and run the following commands
pip install -r test-requirements.txt pytest
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 |
|---|---|---|
| x_my_pay_quicker_version | str |
Date-based API Version specified in the header required on all calls. Default: "2026.02.01" |
| sandbox_instance | SandboxInstance |
Sandbox Environments Default: "sandbox" |
| uat_instance | UatInstance |
UAT Environments Default: "uat1" |
| environment | Environment |
The API environment. Default: Environment.SANDBOX |
| http_client_instance | Union[Session, HttpClientProvider] |
The Http Client passed from the sdk user for making requests |
| override_http_client_configuration | bool |
The value which determines to override properties of the passed Http Client from the sdk user |
| http_call_back | HttpCallBack |
The callback value that is invoked before and after an HTTP call is made to an endpoint |
| timeout | float |
The value to use for connection timeout. Default: 60 |
| max_retries | int |
The number of times to retry an endpoint call if it fails. Default: 0 |
| backoff_factor | float |
A backoff factor to apply between attempts after the second try. Default: 2 |
| retry_statuses | Array of int |
The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] |
| retry_methods | Array of string |
The http methods on which retry is to be done. Default: ["GET", "PUT"] |
| proxy_settings | ProxySettings |
Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | LoggingConfiguration |
The SDK logging configuration for API calls |
| server_credentials | ServerCredentials |
The credential object for OAuth 2 Client Credentials Grant |
| clientside_credentials | ClientsideCredentials |
The credential object for OAuth 2 Bearer token |
The API client can be initialized as follows:
Code-Based Client Initialization
import logging
from payquickersdk.configuration import Environment
from payquickersdk.http.auth.clientside import ClientsideCredentials
from payquickersdk.http.auth.server import ServerCredentials
from payquickersdk.logging.configuration.api_logging_configuration import LoggingConfiguration
from payquickersdk.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from payquickersdk.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from payquickersdk.models.o_auth_scope_server import OAuthScopeServer
from payquickersdk.models.sandbox_instance import SandboxInstance
from payquickersdk.models.uat_instance import UatInstance
from payquickersdk.pay_quicker_sdk_client import PayQuickerSdkClient
client = PayQuickerSdkClient(
x_my_pay_quicker_version='2026.02.01',
server_credentials=ServerCredentials(
o_auth_client_id='OAuthClientId',
o_auth_client_secret='OAuthClientSecret',
o_auth_scopes=[
OAuthScopeServer.READONLY,
OAuthScopeServer.MODIFY
]
),
clientside_credentials=ClientsideCredentials(
access_token='AccessToken'
),
environment=Environment.SANDBOX,
sandbox_instance=SandboxInstance.SANDBOX,
uat_instance=UatInstance.UAT1,
logging_configuration=LoggingConfiguration(
log_level=logging.INFO,
request_logging_config=RequestLoggingConfiguration(
log_body=True
),
response_logging_config=ResponseLoggingConfiguration(
log_headers=True
)
)
)
Environment-Based Client Initialization
from payquickersdk.pay_quicker_sdk_client import PayQuickerSdkClient
# Specify the path to your .env file if it’s located outside the project’s root directory.
client = PayQuickerSdkClient.from_environment(dotenv_path='/path/to/.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.
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
- ProxySettings
- Environment-Based Client Initialization
- AbstractLogger
- LoggingConfiguration
- RequestLoggingConfiguration
- ResponseLoggingConfiguration
HTTP
Utilities
Metadata
Release files for payquicker-api-sdk 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| payquicker_api_sdk-1.0.0.tar.gz | 162.6 kB | Without provenance | Details for payquicker_api_sdk-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| payquicker_api_sdk-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for payquicker_api_sdk-1.0.0-py3-none-any.whl |
Total release size: 577.8 kB
Release files / payquicker_api_sdk-1.0.0.tar.gz
| Download URL | payquicker_api_sdk-1.0.0.tar.gz |
|---|---|
| Size | 162.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e8e97a68871418bc65ef4d0f6015d44ed3ff9d10ba690761b7771c058d09cd2e
|
|
BLAKE2b-256 checksum How to use checksums |
250335d5b1d26e7090cf8e74ca81bdd5a1edb48d6e144e85c6503ff21424b988
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Release files / payquicker_api_sdk-1.0.0-py3-none-any.whl
| Download URL | payquicker_api_sdk-1.0.0-py3-none-any.whl |
|---|---|
| Size | 415.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f679ee0a78591027101882eb7f1a518b9a28f2945f2fc812cb629893afd68947
|
|
BLAKE2b-256 checksum How to use checksums |
c9c2e5a3880ec0206d3bada0b4f6b1e956cf492d7edbb6e29d5f3dc89b8083e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.13
|
Security for payquicker-api-sdk 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.