Payout Page Overview

A Payout Page is the core resource for Payout. It gives you a single, hosted flow to send money to your customers — across multiple payout methods — without building custom integrations.

Why use payout pages?

  • One integration → supports various payout methods (e.g. bank transfers, crypto payouts)
  • Customer choice → customers have the flexibility to decide how they want to receive the funds
  • Simpler UX → Breeze hosts the page, collects customer details and handles compliance checks
  • Real-time updates → receive webhook events whenever the payout page status changes

How it works

flowchart TD
    A["Merchant creates Payout Page (API)"] --> B[Merchant redirects customer to hosted Payout Page]
    B --> C[Customer confirms payout method & KYC verification]
    C --> D[Breeze processes payout]
    D --> E[Merchant receives webhook events]

1. Create a Payout Page

  • Call Breeze’s Payout Page API with the payout amount and the recipient’s email
  • Breeze returns a unique payout page URL in the response

2. Redirect the Customer

  • Redirect the customer to the payout page URL

3. Customer confirms payout & Completes KYC (if required)

  • The customer selects a preferred payout method (e.g. bank account or crypto wallet)
  • If the customer is new to Breeze, they must complete a one-time KYC verification before payout processing

4. Process the Payout

  • Breeze processes the payout through the selected method

5. Stay in Sync

  • Your system listens for webhook events (e.g. processed, refunded, expired) to track status changes