Open

Python SDK

Build synchronous or async SumUp integrations with Python.

sumup-py(Opens in a new tab) provides first-party Python bindings for every SumUp API. It ships both synchronous and asynchronous clients powered by httpx, includes Pydantic models for request bodies, and offers type hints for modern editors.

Installation

Install with pip install sumup. If you use uv(Opens in a new tab), run uv add sumup.

Configure Authentication

Expose your secret API key or OAuth access token as an environment variable and pass it to either the synchronous Sumup or asynchronous AsyncSumup client. You can also pass the key manually:

1
client = Sumup(api_key="sup_sk_MvxmLOl0...")

Examples

Online Payment Checkout

1
import os
2

3
from sumup import Sumup
4
from sumup.checkouts.resource import CreateCheckoutBody
5

6

7
client = Sumup(api_key=os.environ["SUMUP_API_KEY"])
8
checkout = client.checkouts.create(
9
    CreateCheckoutBody(
10
        merchant_code=os.environ["SUMUP_MERCHANT_CODE"],
11
        amount=25.00,
12
        checkout_reference="ORDER-1001",
13
        currency="EUR",
14
        description="Online payment via Payment Widget",
15
    )
16
)
17

18
print(checkout.id)
19
# Return checkout.id to your webpage so the SumUp Payment Widget can complete the payment.

Cloud API Checkout

1
import asyncio
2
import os
3
from time import time
4

5
from sumup import AsyncSumup
6
from sumup.readers.resource import (
7
    CreateReaderCheckoutBody,
8
    CreateReaderCheckoutBodyAffiliate,
9
    CreateReaderCheckoutBodyTotalAmount,
10
)
11

12

13
async def create_solo_checkout() -> None:
14
    client = AsyncSumup(api_key=os.environ["SUMUP_API_KEY"])
15
    merchant_code = os.environ["SUMUP_MERCHANT_CODE"]
16
    readers = await client.readers.list(merchant_code)
17
    solo = next((reader for reader in readers.items if reader.device.model == "solo"), None)
18
    if solo is None:
19
        raise RuntimeError("Pair a Solo reader before using the Cloud API.")
20

21
    checkout = await client.readers.create_checkout(
22
        merchant_code,
23
        solo.id,
24
        CreateReaderCheckoutBody(
25
            total_amount=CreateReaderCheckoutBodyTotalAmount(currency="EUR", minor_unit=2, value=1500),
26
        ),
27
    )
28

29
    print(checkout.data.client_transaction_id)
30

31

32
asyncio.run(create_solo_checkout())

Edit page