Python
Officiellt Python SDK för Cost+ betalningsgateway
Officiellt Python SDK för Cost+ betalningsgateway. Förenklar HPP-omdirigeringsflödet (Hosted Payment Page), HMAC payload-signering och webhook-verifiering.
Funktioner
- Minimala beroenden — bara
requests - Fullständiga type hints och frusna dataclass-returtyper
- HMAC-SHA256 signaturgenerering och verifiering med konstant tid
- Webhook-tolkning + API-baserad orderverifiering
- Testad med Python 3.10, 3.11 och 3.12
Krav
- Python 3.10 eller senare
- Ett Cost+-handelskonto — dashboard.costplus.io
Installation
pip install nopayn-sdkSnabbstart
1. Initiera klienten
from nopayn import NoPaynClient
client = NoPaynClient(
api_key="your-api-key",
merchant_id="your-project",
)2. Skapa en betalning och omdirigera till 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",
)
# Redirect the customer
# result.order_url → HPP (customer picks payment method)
# result.payment_url → direct link to the first transaction's payment method
# result.signature → HMAC-SHA256 for verification
# result.order_id → NoPayn order UUID3. Hantera webhooken (Flask-exempel)
@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":
# Fulfil the order
pass
return "", 200API-referens
NoPaynClient(api_key, merchant_id, base_url?)
| Parameter | Typ | Obligatorisk | Standard |
|---|---|---|---|
api_key | str | Ja | — |
merchant_id | str | Ja | — |
base_url | str | Nej | https://api.nopayn.co.uk |
client.create_order(**kwargs) -> Order
Skapar en order via POST /v1/orders/.
| Parameter | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
amount | int | Ja | Belopp i minsta valutaenhet (cent) |
currency | str | Ja | ISO 4217-kod (EUR, GBP, USD, NOK, SEK) |
merchant_order_id | str | Nej | Din interna orderreferens |
description | str | Nej | Orderbeskrivning |
return_url | str | Nej | Omdirigering efter lyckad betalning |
failure_url | str | Nej | Omdirigering vid avbrytning/utgång/fel |
webhook_url | str | Nej | Asynkrona statusändringsnotifieringar |
locale | str | Nej | HPP-språk (en-GB, de-DE, nl-NL, etc.) |
payment_methods | list[str] | Nej | Filtrera HPP-metoder |
expiration_period | str | Nej | ISO 8601-duration (PT30M) |
Tillgängliga betalningsmetoder: credit-card, apple-pay, google-pay, vipps-mobilepay
client.get_order(order_id) -> Order
Hämtar orderdetaljer via GET /v1/orders/{id}/.
client.create_refund(order_id, amount, description?) -> Refund
Utfärdar en fullständig eller partiell återbetalning via POST /v1/orders/{id}/refunds/.
client.generate_payment_url(**kwargs) -> PaymentUrlResult
Bekvämlighetsmetod som skapar en order och returnerar:
PaymentUrlResult(
order_id="...", # NoPayn order UUID
order_url="...", # HPP URL
payment_url="...", # Direct payment URL (first transaction)
signature="...", # HMAC-SHA256 of amount:currency:order_id
order=Order(...), # Full order object
)client.generate_signature(amount, currency, order_id) -> str
Genererar en HMAC-SHA256 hex-signatur.
client.verify_signature(amount, currency, order_id, signature) -> bool
Verifiering med konstant tid av en HMAC-SHA256-signatur.
client.verify_webhook(raw_body) -> VerifiedWebhook
Tolkar webhook-kroppen och anropar sedan GET /v1/orders/{id}/ för att verifiera faktisk status.
Fristående HMAC-verktyg
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)Datatyper
Alla API-svar returneras som frusna dataclasses:
| Klass | Fält |
|---|---|
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 |
Felhantering
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 errorOrderstatusar
| Status | Slutgiltig? | Beskrivning |
|---|---|---|
new | Nej | Order skapad |
processing | Nej | Betalning pågår |
completed | Ja | Betalning lyckades — leverera varorna |
cancelled | Ja | Betalning avbruten av kunden |
expired | Ja | Betalningslänken löpte ut |
error | Ja | Tekniskt fel |
Bästa praxis för webhooks
- Verifiera alltid via API:et — webhook-payloaden innehåller bara order-ID:t, aldrig statusen. SDK:ts
verify_webhook()gör detta automatiskt. - Returnera HTTP 200 för att bekräfta mottagandet. Annan kod utlöser upp till 10 omförsök (2 minuter emellan).
- Implementera en reservpoller — för ordrar äldre än 10 minuter som inte har nått slutgiltig status, polla
get_order()som säkerhetsnät. - Var idempotent — du kan ta emot samma webhook flera gånger.
Testkort
Använd dessa kort i Cost+ testläge (sandbox-webbplats):
| Kort | Nummer | Noteringar |
|---|---|---|
| Visa (lyckad) | 4111 1111 1111 1111 | Valfritt CVV |
| Mastercard (lyckad) | 5544 3300 0003 7 | Valfritt CVV |
| Visa (nekad) | 4111 1111 1111 1105 | Do Not Honor |
| Visa (otillräckligt saldo) | 4111 1111 1111 1151 | Insufficient Funds |
Använd valfritt framtida utgångsdatum och valfri 3-siffrig CVC.
Demoapplikation
En Flask-baserad demoapplikation ingår i GitHub-repositoryt för att testa det fullständiga betalningsflödet.
Support
Behöver du hjälp? Kontakta vårt supportteam på support@costplus.io.