Which method to choose?

Decision guide

I need to...	Method	When to use it
Immediate mobile payment	MB WAY	Customer has the MB WAY app. 5-min approval.
ATM or homebanking reference	Multibanco	Customer pays at their own pace (1–30 days).
Card on a hosted page	Credit Card	Web checkout with 3D-Secure.
Apple Wallet (iOS/Safari)	Apple Pay	Tokenised in-app/in-browser payment.
Google Pay (Android/Chrome)	Google Pay	Tokenised in-app/in-browser payment.
Let the customer pick	Pay By Link	Send one URL — invoicing, social, no checkout.
Refund a previous payment	Refunds	Total or partial, requires OAuth credentials.

Every payment method returns a PaymentResult. Common fields: transaction_id, status (PaymentStatus), amount (Decimal), payment_url (when the customer is redirected), raw_response (the unparsed eupago JSON).

The full payment lifecycle

Every method shares the same shape: create → wait → webhook → (optionally) refund. The differences are only in how the customer pays.

sequenceDiagram
    participant App
    participant eupago
    participant Customer
    App->>eupago: create_payment / create_reference / pay_by_link
    eupago-->>App: PaymentResult (transaction_id, status PENDING, payment_url)
    App->>Customer: Show entity+reference / Redirect to payment_url / Send link
    Customer->>eupago: Completes payment (app / ATM / card form)
    eupago->>App: Webhook (status PAID)
    Note over App,eupago: Optional refund (no webhook for refunds)
    App->>eupago: refunds.refund(transaction_id, value)
    eupago-->>App: PaymentResult (status REFUNDED)

Same call shape across methods

from decimal import Decimal
from eupago import EupagoClient

client = EupagoClient(api_key="...", sandbox=True)

result = client.<method>.create_payment(
    order_id="ORD-001",
    amount=Decimal("49.90"),
    ...
)

print(result.status)          # PaymentStatus.PENDING
print(result.transaction_id)  # Transaction ID
print(result.payment_url)     # Hosted page URL (when applicable)
print(result.raw_response)    # Raw eupago JSON (always)

See the per-method pages for the exact parameters, and the examples folder for runnable, end-to-end scripts.