Three verification modes, one client — verify that a "paid" slip image or QR payload really moved money in the bank system:

Features

Quick Start

Install with any package manager:

pip install bank-slip-verifier
# or
uv add bank-slip-verifier
# or
poetry add bank-slip-verifier

Client is a ready-to-use static wrapper around the hosted deployment — no setup needed:

from bank_slip_verifier import Client

# 1. Verify a QR payload only, no image (fastest):
result = Client.verify_qr_code(qr_code_data="004...", amount=100)
print(result.data.ref)  # bank transaction reference

# 2. Verify a slip image against a known amount (recommended — faster):
data = Client.verify_amount(img="data:image/jpeg;base64,...", amount=100).data
print(data.amount == 100)  # True — the bank confirmed the transfer

# 3. Unknown amount — let OCR read it from the image (slowest):
detected = Client.detect_amount(img="data:image/jpeg;base64,...").data
print(detected.amount)  # amount found by OCR, then verified

Every result has the same shape:

SlipResult(
    ok=True,
    message="Slip processed successfully.",
    from_cache=False,  # True when answered from the server cache
    data=SlipData(
        ref="202602032204376094",
        date="2026-03-17T10:00:00.000Z",
        amount=100.0,
        sender_bank="004",
        sender_name="John Doe",
        sender_id="xxx-x-xxxxx-x",
        receiver_bank="014",
        receiver_name="Jane Doe",
        receiver_id="xxx-x-xxxxx-x",
    ),
)

Extra fields come back on rich responses (verified, reference_1/2/3, sender_bank_details, receiver_bank_details).

Bring your own deployment (or configure)

from bank_slip_verifier import create_client

client = create_client()  # hosted: https://slip-c.oiio.download
# or
custom = create_client(base_url="https://your-deployment.example.com")
# or configure the static client:
Client.configure(base_url="https://your-deployment.example.com")

result = custom.verify_amount(img="data:image/jpeg;base64,...", amount=100)

Base URL resolution order: base_url option > BANK_SLIP_VERIFIER_BASE_URL environment variable > hosted deployment:

BANK_SLIP_VERIFIER_BASE_URL=https://staging.example.com python app.py

Timeout

Verification can take up to 25 seconds (OCR endpoint). The API docs require an HTTP timeout of 30 s or more — this client defaults to 35 s and raises SlipTimeoutError when a response does not arrive in time. Tighten it only if you know what you are doing:

client = create_client(timeout_ms=60_000)  # or lower, but >= 30_000

Terms of Service

The API rejects every request unless TOS, privacy and EULA are accepted. The client sends {"tos": True, "privacy": True, "eula": True} by default (using the service implies consent). Override at client level or per call:

create_client(consent={"tos": True, "privacy": False, "eula": True})  # client-level
client.detect_amount(img, consent={"tos": False})  # per-call (wins)

Error handling

All errors extend SlipError. The API's failures arrive as SlipApiError with the HTTP status, the documented error slug and the raw envelope:

from bank_slip_verifier import Client, SlipApiError, SlipTimeoutError, SlipError

try:
    result = Client.verify_amount(img=img, amount=100)
except SlipApiError as err:
    print(err.status, err.slug, err.message)
    # 422 'amount-not-verified' '[amount-not-verified] Amount not verified'
    if err.slug == "amount-not-verified":
        # show the customer the expected amount again — the slip does not match
        ...
except SlipTimeoutError:
    # verification took longer than timeout_ms — retry later
    ...

SlipApiError.slug is one of these values (SLIP_ERROR_SLUGS and is_slip_error_slug are exported for runtime checks).

Live smoke tests

The package ships live smoke tests against the real deployment (skipped by default):

LIVE=1 pytest

API

Credits

Powered by the OIIO Service Slip Verify API.

License

MIT © ByteInDev