High-Level Flow

How It Works (Conceptual Overview)

%%{init: {'theme': 'base', 'themeVariables': { 'textColor': '#c0c0c0' }}}%%
sequenceDiagram
    participant M as Your Backend
    participant B as Breeze Payment Service
    
    M->>B: (1) Create Payment Page (API call)
    B-->>M: (1') Return Payment URL in Response
    M->>B: (2) Redirect User to Payment URL
    B-->>M: (3) Webhook Notification upon Payment Status

1. Create a Payment Page
   • Call Breeze’s API with basic parameters (amount, currency, return URL, etc.).
   • In return, you receive a unique payment_url.
2. Redirect the User
   • Send the user’s browser to the payment_url for them to complete the payment.
   • Breeze handles the user’s card or crypto transaction flow seamlessly.
3. Receive Webhook
   • Once payment succeeds or fails, Breeze sends a webhook to your server.
   • Use this notification to update your order status or trigger any post-payment actions.

Key Takeaways:

• You only need a single HTTP call to generate a payment page.
• The user is redirected to Breeze’s hosted flow, and you don’t have to manage card or crypto details yourself.
• A webhook notifies you automatically of the outcome, so you can keep your records in sync without additional polling.