Python SDK

The official Python SDK provides fully typed synchronous and asynchronous clients for the OurPay API.

The new SDK is currently in public preview. Preview builds are distributed as versioned wheels from the OurPay documentation site until the PyPI package is available.

Installation

The SDK requires Python 3.11 or later.

Terminal

uv add "ourpay-sdk @ https://docs.ourpay.dev/downloads/ourpay_sdk-1.0.0a19-py3-none-any.whl"

Terminal

pip install "ourpay-sdk @ https://docs.ourpay.dev/downloads/ourpay_sdk-1.0.0a19-py3-none-any.whl"

Quickstart

Create an organization access token, store it in OURPAY_ACCESS_TOKEN, and make your first request:

main.py

import os

from ourpay.v2026_10 import OurPay

ourpay = OurPay(os.environ["OURPAY_ACCESS_TOKEN"])

customer_state = ourpay.customers.get_state_external("customer_external_id")
print(customer_state)

Async client

Use OurPayAsync in asynchronous applications:

async_main.py

import asyncio
import os

from ourpay.v2026_10 import OurPayAsync


async def main() -> None:
    ourpay = OurPayAsync(os.environ["OURPAY_ACCESS_TOKEN"])
    customer_state = await ourpay.customers.get_state_external(
        "customer_external_id"
    )
    print(customer_state)


asyncio.run(main())

The import path pins your client to the 2026-10 API version.

Context managers

Both clients support context managers to close their HTTP connections automatically when the block exits. For synchronous applications, use OurPay with with:

import os

from ourpay.v2026_10 import OurPay

with OurPay(os.environ["OURPAY_ACCESS_TOKEN"]) as ourpay:
    customer_state = ourpay.customers.get_state_external("customer_external_id")
    print(customer_state)

For asynchronous applications, use OurPayAsync with async with:

import asyncio
import os

from ourpay.v2026_10 import OurPayAsync


async def main() -> None:
    async with OurPayAsync(os.environ["OURPAY_ACCESS_TOKEN"]) as ourpay:
        customer_state = await ourpay.customers.get_state_external(
            "customer_external_id"
        )
        print(customer_state)


asyncio.run(main())

Sandbox environment

The client uses production by default. Pass environment="sandbox" to use the isolated sandbox environment:

ourpay = OurPay(
    os.environ["OURPAY_ACCESS_TOKEN"],
    environment="sandbox",
)

Download the current wheel.

Bootup

Features

Integrate

Merchant of Record (MoR)

Installation

Quickstart

Async client

Context managers

Sandbox environment

​Installation

​Quickstart

​Async client

​Context managers

​Sandbox environment

Installation

Quickstart

Async client

Context managers

Sandbox environment