Python
Uradni Python SDK za plačilni prehod Cost+
Uradni Python SDK za plačilni prehod Cost+. Poenostavlja tok preusmeritve HPP (gostovane plačilne strani), HMAC podpisovanje koristnih podatkov in preverjanje webhook-ov.
Lastnosti
- Minimalne odvisnosti — samo
requests - Polni type hints in zamrznjeni dataclass tipi vrnjenih vrednosti
- HMAC-SHA256 generiranje podpisov in preverjanje s konstantnim časom
- Razčlenjevanje webhook-ov + preverjanje naročil na osnovi API-ja
- Testirano na Python 3.10, 3.11 in 3.12
Zahteve
- Python 3.10 ali novejši
- Trgovski račun Cost+ — dashboard.costplus.io
Namestitev
pip install nopayn-sdkHitri začetek
1. Inicializirajte odjemalca
from nopayn import NoPaynClient
client = NoPaynClient(
api_key="your-api-key",
merchant_id="your-project",
)2. Ustvarite plačilo in preusmerite na HPP
result = client.generate_payment_url(
amount=1295, # €12.95 in cents
currency="EUR",
merchant_order_id="ORDER-001",
description="Premium Widget",
return_url="https://shop.example.com/success",
failure_url="https://shop.example.com/failure",
webhook_url="https://shop.example.com/webhook",
locale="en-GB",
expiration_period="PT30M",
)
# Preusmerite stranko
# result.order_url → HPP (stranka izbere plačilno metodo)
# result.payment_url → neposredna povezava do plačilne metode prve transakcije
# result.signature → HMAC-SHA256 za preverjanje
# result.order_id → NoPayn UUID naročila3. Obdelajte webhook (primer Flask)
@app.route("/webhook", methods=["POST"])
def webhook():
verified = client.verify_webhook(request.get_data(as_text=True))
print(verified.order.status) # 'completed', 'cancelled', etc.
print(verified.is_final) # True when the order won't change
if verified.order.status == "completed":
# Izpolnite naročilo
pass
return "", 200API referenca
NoPaynClient(api_key, merchant_id, base_url?)
| Parameter | Tip | Obvezno | Privzeto |
|---|---|---|---|
api_key | str | Da | — |
merchant_id | str | Da | — |
base_url | str | Ne | https://api.nopayn.co.uk |
client.create_order(**kwargs) -> Order
Ustvari naročilo prek POST /v1/orders/.
| Parameter | Tip | Obvezno | Opis |
|---|---|---|---|
amount | int | ja | Znesek v manjši enoti ISO 4217 valute (na primer centi za EUR) |
currency | str | Da | Koda ISO 4217 (EUR, GBP, USD, NOK, SEK) |
merchant_order_id | str | Ne | Vaša interna referenca naročila |
description | str | Ne | Opis naročila |
return_url | str | Ne | Preusmeritev po uspešnem plačilu |
failure_url | str | Ne | Preusmeritev ob preklicu/poteku/napaki |
webhook_url | str | Ne | Asinhrona obvestila o spremembi statusa |
locale | str | Ne | Jezik HPP (en-GB, de-DE, nl-NL itd.) |
payment_methods | list[str] | Ne | Filtriraj metode HPP |
expiration_period | str | Ne | Trajanje ISO 8601 (PT30M) |
Razpoložljive plačilne metode: credit-card, apple-pay, google-pay, vipps-mobilepay
client.get_order(order_id) -> Order
Pridobi podrobnosti naročila prek GET /v1/orders/{id}/.
client.create_refund(order_id, amount, description?) -> Refund
Izda celotno ali delno vračilo prek POST /v1/orders/{id}/refunds/.
client.generate_payment_url(**kwargs) -> PaymentUrlResult
Priročna metoda, ki ustvari naročilo in vrne:
PaymentUrlResult(
order_id="...", # NoPayn UUID naročila
order_url="...", # HPP URL
payment_url="...", # Neposredni plačilni URL (prva transakcija)
signature="...", # HMAC-SHA256 od amount:currency:order_id
order=Order(...), # Celoten objekt naročila
)client.generate_signature(amount, currency, order_id) -> str
Generira HMAC-SHA256 šestnajstiški podpis.
client.verify_signature(amount, currency, order_id, signature) -> bool
Preverjanje HMAC-SHA256 podpisa s konstantnim časom.
client.verify_webhook(raw_body) -> VerifiedWebhook
Razčleni telo webhook-a, nato pokliče GET /v1/orders/{id}/ za preverjanje dejanskega statusa.
Samostojne HMAC pripomočke
from nopayn import generate_signature, verify_signature
sig = generate_signature("your-api-key", 1295, "EUR", "order-uuid")
ok = verify_signature("your-api-key", 1295, "EUR", "order-uuid", sig)Podatkovni tipi
Vsi API odgovori so vrnjeni kot zamrznjeni dataclass objekti:
| Razred | Polja |
|---|---|
Order | id, amount, currency, status, created, modified, transactions, description, merchant_order_id, return_url, failure_url, order_url, completed |
Transaction | id, amount, currency, status, created, modified, payment_method, payment_url, expiration_period |
Refund | id, amount, status |
PaymentUrlResult | order_id, order_url, payment_url, signature, order |
VerifiedWebhook | order_id, order, is_final |
Obravnava napak
from nopayn import ApiError, NoPaynError, WebhookError
try:
client.create_order(amount=100, currency="EUR")
except ApiError as exc:
print(exc.status_code) # 401, 400, etc.
print(exc.error_body) # Raw API error response
except NoPaynError as exc:
print(exc) # Network or parsing errorStatusi naročil
| Status | Končni? | Opis |
|---|---|---|
new | Ne | Naročilo ustvarjeno |
processing | Ne | Plačilo v teku |
completed | Da | Plačilo uspešno — dostavite blago |
cancelled | Da | Plačilo preklicano s strani stranke |
expired | Da | Plačilna povezava je potekla |
error | Da | Tehnična napaka |
Najboljše prakse za webhook-e
- Vedno preverite prek API-ja — koristni podatki webhook-a vsebujejo samo ID naročila, nikoli statusa. SDK-jev
verify_webhook()to naredi samodejno. - Vrnite HTTP 200 za potrditev prejema. Katerakoli druga koda sproži do 10 ponovnih poskusov (2 minuti narazen).
- Implementirajte rezervno poizvedovanje — za naročila, starejša od 10 minut, ki še niso dosegla končnega statusa, poizvedujte
get_order()kot varnostno mrežo. - Bodite idempotentni — isti webhook lahko prejmete večkrat.
Testne kartice
Uporabite te kartice v testnem načinu Cost+ (spletno mesto peskovnika):
| Kartica | Številka | Opombe |
|---|---|---|
| Visa (uspeh) | 4111 1111 1111 1111 | Katerikoli CVV |
| Mastercard (uspeh) | 5544 3300 0003 7 | Katerikoli CVV |
| Visa (zavrnjena) | 4111 1111 1111 1105 | Zavrnitev |
| Visa (nezadostna sredstva) | 4111 1111 1111 1151 | Nezadostna sredstva |
Uporabite katerikoli prihodnji datum veljavnosti in katerokoli 3-mestno CVC kodo.
Predstavitvena aplikacija
Predstavitvena aplikacija na osnovi Flask je vključena v GitHub repozitorij za testiranje celotnega plačilnega toka.
Podpora
Potrebujete pomoč? Obrnite se na našo ekipo za podporo na support@costplus.io.