Python client for the epoint.az payment gateway.
Covers all 30 documented endpoints: payments, saved cards, refunds and payouts, split payments, pre-authorisation, installments, wallets, Apple Pay and Google Pay, invoices, and B2B transfers. Sync and async, fully typed, one dependency.
pip install epointfrom epoint import EpointClient
client = EpointClient(public_key="i000000001", private_key="your-private-key")
payment = client.create_payment(amount=30.75, order_id="order-1", description="Test order")
print(payment.redirect_url)Send the customer to payment.redirect_url. When they finish, epoint calls your result URL. Verify
it before trusting it:
from epoint import SignatureError
try:
callback = client.verify_callback(data, signature)
except SignatureError:
return "invalid", 400
if callback.ok:
fulfil(callback.order_id, callback.transaction)AsyncEpointClient has the same methods, awaited:
from epoint import AsyncEpointClient
async with AsyncEpointClient(public_key="i000000001", private_key="your-private-key") as client:
payment = await client.create_payment(amount=30.75, order_id="order-1")
status = await client.get_status(payment.transaction)verify_callback stays synchronous on both clients, since it only does a signature check.
Pass keys directly, or read them from the environment:
client = EpointClient.from_env()| Variable | |
|---|---|
EPOINT_PUBLIC_KEY |
Required |
EPOINT_PRIVATE_KEY |
Required |
EPOINT_BASE_URL |
Defaults to https://epoint.az |
EPOINT_LANGUAGE |
Defaults to az |
EPOINT_SUCCESS_REDIRECT_URL |
Optional default for payment methods |
EPOINT_FAILED_REDIRECT_URL |
Optional default for payment methods |
language and currency are set once on the client and can be overridden per call.
There is a local sandbox that behaves like the real gateway, so you can build and test without a merchant account or real money:
client = EpointClient(
public_key="i000000001",
private_key="sandbox_private_key_0000000001",
base_url="http://localhost:8181",
)See epoint-sandbox. Switching to production means
changing base_url and the keys, nothing else.
Most methods return a Response. Read known fields as attributes, anything else through get or
raw:
r = client.get_status("te0000000001")
r.status # "success"
r.ok # True
r.get("rrn") # bank reference number
r.raw # the full response dictcreate_payment, reserve, create_split_payment and the other checkout methods return
redirect_url. get_installment_plans returns a list and list_wallets returns a dict.
| Group | Methods |
|---|---|
| Checkout | create_payment, create_payment_request, create_amex_payment, change_payment_sum |
| Status | get_status, get_card_status, get_bank_transfer |
| Split | create_split_payment, split_charge_saved_card |
| Pre-auth | reserve, capture |
| Saved cards | register_card, register_card_and_pay, charge_saved_card |
| Money back | refund, reverse |
| Installments | get_installment_plans, pay_by_installment |
| Wallets | list_wallets, pay_with_wallet |
| Apple Pay, Google Pay | create_widget |
| Invoices | create_invoice, update_invoice, get_invoice, list_invoices, send_invoice_sms, send_invoice_email |
| B2B | create_bank_transfer, get_bank_transfer |
| Health | heartbeat |
| Exception | Raised when |
|---|---|
GatewayError |
epoint returned status: error or failed. Carries code, message, payload. |
TransportError |
Network failure, or a non-JSON or 4xx/5xx response |
SignatureError |
A callback's signature did not match, or its data would not decode |
All three inherit from EpointError.
Epoint signs with base64(sha1_raw(private_key + data + private_key)). The client builds and
verifies these for you. The digest is the raw 20 bytes, not the hex string, which is where most
hand-rolled integrations go wrong.
An independent client for developers integrating with epoint.az.
MIT licensed.