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.

📘

Payout payment methods include ACH, RTP (Same-day ACH on FedNow), Push-to-Card and Crypto wallets including ETH, SOL, BTC, USDC and other tokens.

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 the Payout Page API with the payout amount, funding currency, and customer details. Specify releaseMethod as MANUAL (you control when funds are released) or AUTOMATIC (released immediately after the customer completes the flow). Breeze returns a unique hosted payout page URL.

2. Redirect the Customer

Redirect the customer to the payout page URL. Breeze hosts the entire customer-facing flow — the customer sees a branded page where they select their preferred payout method (bank transfer, push-to-card, or crypto wallet).

3. Customer Confirms Payout & Completes KYC

The customer selects a payout method and enters their details (e.g. bank account or wallet address). If this is their first payout with Breeze, they'll complete a one-time KYC verification before funds can be released. Returning customers skip this step.

4. Process the Payout

If releaseMethod is MANUAL, you must call the release endpoint to initiate fund movement. If AUTOMATIC, Breeze proceeds immediately. Breeze auto-selects the optimal rail (RTP for near-instant, ACH for 1–3 business days, or crypto).

5. Stay in Sync

Your system receives webhook events as the payout progresses through each status (e.g. PROCESSING, COMPLETED, REFUNDED). Use these to update your internal records and notify your customer.