multisafepay 3.1.0

Multisafepay API wrapper

MultiSafepay Python SDK

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.
• Event stream subscriptions additionally require the transport to implement the HTTPStreamingTransport protocol (adds open_stream(...) returning an HTTPStreamResponse with readline(), close(), and raise_for_status()).
• 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).

The built-in RequestsTransport implements both HTTPTransport and HTTPStreamingTransport, so the same configured requests.Session is reused for regular requests and SSE streams. Custom transports that only implement HTTPTransport (request(...)) can still be used for regular API calls, but SSE subscriptions fail explicitly until they also implement HTTPStreamingTransport. The SDK does not fall back to another HTTP library for event streams.

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)

Initialize with scoped credentials

Use ScopedCredentialResolver when different API keys must be selected per auth scope. When credential_resolver is provided, api_key becomes optional.

from multisafepay import Sdk
from multisafepay.client import ScopedCredentialResolver


credential_resolver = ScopedCredentialResolver(
    default_api_key="<default_api_key>",
    partner_affiliate_api_key="<partner_api_key>",
    terminal_group_api_keys={
        "<terminal_group_id>": "<terminal_group_api_key>",
    },
)

sdk = Sdk(
    is_production=False,
    credential_resolver=credential_resolver,
)

Event stream subscriptions

Use EventManager to subscribe to MultiSafepay SSE streams directly, or to subscribe from an order response that already contains event credentials.

from multisafepay import Sdk
from multisafepay.client import ScopedCredentialResolver


credential_resolver = ScopedCredentialResolver(
    default_api_key="<default_api_key>",
    terminal_group_api_keys={
        "<terminal_group_id>": "<terminal_group_api_key>",
    },
)

sdk = Sdk(
    is_production=False,
    credential_resolver=credential_resolver,
)

order_manager = sdk.get_order_manager()
event_manager = sdk.get_event_manager()

# Build your OrderRequest here, for example:
# from multisafepay.api.paths.orders.request.order_request import OrderRequest
# order_request = OrderRequest(...)

create_response = order_manager.create(
    request_order=order_request,
    terminal_group_id="<terminal_group_id>",
)
order = create_response.get_data()

with event_manager.subscribe_order_events(order, timeout=45.0) as stream:
    for event in stream:
        print(event)

Cloud POS order tips

For POS and Cloud POS integrations, you can send tip information as part of the order creation payload with amount_details. Amount values are expressed in the smallest currency unit, so this example sends a total order amount of EUR 1.20 with EUR 0.20 marked as tip.

from multisafepay.api.paths.orders.request import OrderRequest
from multisafepay.api.paths.orders.request.components import (
    AmountDetails,
    Tip,
)


order_request = (
    OrderRequest()
    .add_type("redirect")
    .add_order_id("cloud-pos-order-with-tip")
    .add_description("Cloud POS order with tip")
    .add_amount(120)
    .add_currency("EUR")
    .add_gateway_info({"terminal_id": "<terminal_id>"})
    .add_amount_details(
        AmountDetails().add_tip(Tip().add_amount(20)),
    )
)

The amount_details field serializes to:

{
    "amount_details": {
        "tip": {
            "amount": 20
        }
    }
}

See the full Cloud POS tip example in examples/order_manager/cloud_pos_order_with_tip.py.

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.

The event-stream example in examples/event_manager/subscribe_events.py requires:

export API_KEY="<account_api_key>"
export TERMINAL_GROUP_API_KEY_GROUP_DEFAULT="<terminal_group_api_key>"
export CLOUD_POS_TERMINAL_GROUP_ID="<terminal_group_id>"
export CLOUD_POS_TERMINAL_ID="<terminal_id>"

The SSE E2E test can also run against a dev-backed base URL and optionally resolve the terminal group automatically:

export E2E_NO_SANDBOX_BASE_URL="https://dev-api.example.com/v1/"
export MSP_SDK_BUILD_PROFILE=dev
export MSP_SDK_ALLOW_CUSTOM_BASE_URL=1
export MSP_SDK_CUSTOM_BASE_URL="https://dev-api.example.com/v1/"
export E2E_API_KEY="<account_api_key>"
export E2E_TERMINAL_GROUP_API_KEY_GROUP_DEFAULT="<terminal_group_api_key>"
export E2E_CLOUD_POS_TERMINAL_ID="<terminal_id>"
# Optional when CLOUD_POS_TERMINAL_GROUP_ID is not set
export E2E_PARTNER_API_KEY="<partner_api_key>"

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.

Terminal endpoint examples and E2E checks use a dev-backed base URL because those endpoints are not exercised against the default shared E2E target.

export API_KEY="<account_api_key>"
export PARTNER_API_KEY="<partner_api_key>"  # optional
export MSP_SDK_BUILD_PROFILE=dev
export MSP_SDK_ALLOW_CUSTOM_BASE_URL=1
export MSP_SDK_CUSTOM_BASE_URL="https://dev-api.example.com/v1/"
export E2E_CLOUD_POS_TERMINAL_ID="<terminal_id>"
# Optional: set when you want to skip automatic terminal-group lookup
export CLOUD_POS_TERMINAL_GROUP_ID="<terminal_group_id>"
make test-e2e

Support

Create an issue on this repository or email [e-mail]

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!