onlinepayments-sdk-python3

Introduction

The Python SDK helps you to communicate with the payment platform server API. Its primary features are:

convenient Python library for the API calls and responses
- marshals Python request objects to HTTP requests
- unmarshals HTTP responses to Python response objects or Python exceptions
handling of all the details concerning authentication
handling of required metadata

Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API key.

Structure of this repository

This repository consists out of three main components:

The source code of the SDK itself: /onlinepayments/sdk/
The source code of the SDK unit tests: /tests/unit/
The source code of the SDK integration tests: /tests/integration/

Note that the source code of the unit tests and integration tests can only be found on GitHub.

Requirements

Python 3.7 or higher is required. In addition, the following packages are required:

requests 2.25.0 or higher
requests-toolbelt 0.8.0 or higher

These packages will be installed automatically if the SDK is installed manually or using pip following the below instructions.

Installation

To install the SDK using pip, execute the following command:

pip install onlinepayments-sdk-python3

Alternatively, you can install the SDK from a source distribution file:

Download the latest version of the Python SDK from GitHub. Choose the onlinepayments-sdk-python3-x.y.z.zip file from the releases page, where x.y.z is the version number.
Execute the following command in the folder where the SDK was downloaded to:
Execute the following command in the folder where the SDK was downloaded to:
```
pip install onlinepayments-sdk-python3-x.y.z.zip
```

Uninstalling

After the Python SDK has been installed, it can be uninstalled using the following command:

pip uninstall onlinepayments-sdk-python3

The required packages can be uninstalled in the same way.

Running tests

There are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required. First, some environment variables need to be set: - onlinePayments.api.v1hmac.apiKeyId for the API key id to use. - onlinePayments.api.v1hmac.secretApiKey for the secret API key to use. - onlinePayments.api.merchantId for your merchant ID.

In addition, to run the proxy integration tests, the proxy URI, username and password should be set in the tests/resources/configuration.proxy.ini file.

In order to run the unit and integration tests, the mock backport and mockito are required. These can be installed using the following command:

pip install mock mockito

The following commands can now be executed from the tests directory to execute the tests:

Unit tests:
```
python run_unit_tests.py
```
Integration tests:
```
python run_integration_tests.py
```
Both unit and integration tests:
```
python run_all_tests.py
```

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

onlinepayments_sdk_python3-8.3.0.tar.gz (232.0 kB view details)

Uploaded Jun 21, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

onlinepayments_sdk_python3-8.3.0-py3-none-any.whl (511.8 kB view details)

Uploaded Jun 21, 2026 Python 3

File details

Details for the file onlinepayments_sdk_python3-8.3.0.tar.gz.

File metadata

Download URL: onlinepayments_sdk_python3-8.3.0.tar.gz
Upload date: Jun 21, 2026
Size: 232.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for onlinepayments_sdk_python3-8.3.0.tar.gz
Algorithm	Hash digest
SHA256	`fa54ff008e7eeeda180dfe2aef4c97afa0f6e2859317c590db8f64da5efacc0b`
MD5	`8cd000f2363c7d973521f6466abca411`
BLAKE2b-256	`a5c70e3172f2ca8cfaf466fa52b3170300c2bc2c7f8d5dd3ac2d06ba8f0e1576`

See more details on using hashes here.

File details

Details for the file onlinepayments_sdk_python3-8.3.0-py3-none-any.whl.

File metadata

Download URL: onlinepayments_sdk_python3-8.3.0-py3-none-any.whl
Upload date: Jun 21, 2026
Size: 511.8 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for onlinepayments_sdk_python3-8.3.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`10fdb6365ddcc6183dc9cbb9c5fe9857b2b7851b62479e59599fd31baae4f2bd`
MD5	`13030e22c67bbe8fef50d02cb9fed514`
BLAKE2b-256	`f6152b45449caac86d14347d9f5c4e4e401e7e29806d9e2b120f19ac6dbef0f4`