For AI agents: visit https://docs.breeze.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Breeze public docs
GuidesAPI Reference
Log InBreeze public docs
Guides
Log In
GuidesAPI Reference

Overview & Getting Started

  • Introduction
  • High-Level Flow
  • Quick Start
  • Sign in with Apple

Core Integration Guide

  • API Fundamentals
  • Testing
  • Payin
    • Payin Overview
    • Payment Page — Query Status & Expire
    • Payments SDK (React)
    • Embedding iframe Guidelines
      • Webview Guidelines
      • Handling iframe postMessage events on the parent frame
    • Configuring payment methods on Breeze from client
    • Customized UI for Payment pages
    • Refund
  • Payout (Payout Page)
    • Payout Page Overview
    • Quick Start: Create and Test a Payout Page
    • Payout Page Statuses and Sub-Statuses
    • Releasing a Payout Page
    • Canceling a Payout Page
    • Webhook Events for Payout Pages
    • Headless Payout
    • Configuring payout methods on Breeze from client
    • Sandbox: Advance Payout Page Status
  • Customer
    • Customer Overview
    • Know Your Customer (KYC)
      • KYC Overview
      • Option 1: Onboarding a Customer with KYC Data
      • Option 2: KYC Webhook
      • Option 3: Headless KYC
      • KYC Tiers & Fields
  • Products
  • Subscription
    • Subscription Overview
      • Choosing a Subscription Type
      • Scheduled & Free Trial
      • Discounted Trial
    • Quick Start (Subscription)
    • Webhook Notifications
      • Subscription Events
      • Invoice Events
  • Webhooks
    • Webhooks Overview
    • Webhook Signature Verification
    • Webhook Event Reference
  • Statements
  • Disputes
  • WooCommerce Integration
  • Risk
    • Breeze Risk JS SDK
  • Liquidation Address
    • Overview
    • QuickStart
    • Core Concept
    • Webhooks

Errors & Troubleshooting

  • Error Reference
  • Debugging Payment Failures

Merchant Settlement Guide

  • Your Balances
  • Flow of Funds
  • Minimum Balance
  • Getting Started
  • Every Settlement Day
  • Dashboard Fields
  • Settlement FAQ

MCP Server

  • Connect Breeze to your AI assistant (MCP)
Powered by 

Introduction

    • Why Breeze?
      • All-in-one
      • Risk and Compliance, Fully Handled
    • Get Started
    • Need Help?
    • Explore the Docs