Skip to content

README.md

Latest commit

 

History

History
171 lines (112 loc) · 5.27 KB

README.md

File metadata and controls

171 lines (112 loc) · 5.27 KB

MultiSafepay Python SDK

Code Quality Codecov License Latest stable version Python versions

Easily integrate MultiSafepay's payment solutions into your Python applications with this official API client. This SDK provides convenient access to the MultiSafepay REST API, supports all core payment features, and is designed for seamless integration into any Python-based backend.

About MultiSafepay

MultiSafepay is a Dutch payment services provider, which takes care of contracts, processing transactions, and collecting payment for a range of local and international payment methods. Start selling online today and manage all your transactions in one place!

Installation

If you want to use the built-in default transport, install with the requests extra.

pip install "multisafepay[requests]"

If you want to provide your own transport implementation, install the base package.

pip install multisafepay

HTTP client / transport (optional dependency)

WARNING: This SDK does not have a hard dependency on a specific HTTP client.

The SDK uses a small transport abstraction so you can choose (and swap) the underlying HTTP implementation without affecting the rest of your integration.

How it works

  • The SDK expects an object implementing the HTTPTransport / HTTPResponse protocols defined in src/multisafepay/transport/http_transport.py.
  • If you do not provide a transport, the SDK defaults to RequestsTransport.
  • requests is an optional extra:
    • To use the default transport, install multisafepay[requests].
    • To avoid requests, inject your own transport (for example, httpx or urllib3).

Custom transport example

pip install multisafepay
from multisafepay import Sdk


sdk = Sdk(
    api_key="<api_key>",
    is_production=False,
    transport=my_custom_transport,  # must implement HTTPTransport
)

See transport examples in examples/transport/ (httpx_transport.py, urllib3_transport.py, request_transport.py).

Getting started

Initialize the client

from multisafepay import Sdk

multisafepay_sdk: Sdk = Sdk(api_key='<api_key>', is_production=True)

Development-only custom base URL override

By default, the SDK only targets:

  • test: https://testapi.multisafepay.com/v1/
  • live: https://api.multisafepay.com/v1/

For local development, a custom base URL can be enabled with strict guardrails:

export MSP_SDK_BUILD_PROFILE=dev
export MSP_SDK_ALLOW_CUSTOM_BASE_URL=1

You can provide the custom base URL either via environment variable or via the SDK argument.

Environment variable option:

export MSP_SDK_CUSTOM_BASE_URL="https://dev-api.example.com/v1"

SDK argument option:

from multisafepay import Sdk

sdk = Sdk(
    api_key="<api_key>",
    is_production=False,
    base_url="https://dev-api.example.com/v1",
)

Precedence when both are set:

  • The explicit SDK argument base_url takes priority.
  • If base_url is not passed, MSP_SDK_CUSTOM_BASE_URL is used.

In any non-dev profile (including default release), custom base URLs are blocked and the SDK will only use test/live URLs.

Examples

Go to the folder examples to see how to use the SDK.

Code quality checks

Linting

make lint

Testing

make test

E2E target environment

By default, E2E tests target https://testapi.multisafepay.com/v1/.

Use dedicated E2E variables instead of the general SDK variables:

export E2E_API_KEY="<test_api_key>"
export E2E_BASE_URL="https://testapi.multisafepay.com/v1/"  # optional
make test-e2e

E2E_BASE_URL is optional and can point to any HTTPS base URL used for E2E. When omitted, E2E defaults to testapi.multisafepay.com.

The e2e suite does not use the shared API_KEY variable or the shared MSP_SDK_* custom base URL settings.

Support

Create an issue on this repository or email integration@multisafepay.com

Contributors

If you create a pull request to suggest an improvement, we'll send you some MultiSafepay swag as a thank you!

License

Open Software License (OSL 3.0)

Want to be part of the team?

Are you a developer interested in working at MultiSafepay? Check out our job openings and feel free to get in touch!