# Breeze public docs Documentation > Documentation for Breeze public docs ## Guides: Overview & Getting Started - [Introduction](https://docs.breeze.com/docs/introduction.md) - [High-Level Flow](https://docs.breeze.com/docs/high-level-flow.md) - [Quick Start](https://docs.breeze.com/docs/quick-start.md) - [Sign in with Apple](https://docs.breeze.com/docs/sign-in-with-apple.md) ## Guides: Core Integration Guide - [API Fundamentals](https://docs.breeze.com/docs/api-fundamentals.md) - [Testing](https://docs.breeze.com/docs/testing.md): Test your integration with simulated transactions and webhooks. - Payin - [Payin Overview](https://docs.breeze.com/docs/payment-page-overview.md) - [Payment Page — Query Status & Expire](https://docs.breeze.com/docs/payment-page-query-status-cancel.md) - [Payments SDK (React)](https://docs.breeze.com/docs/payments-sdk.md): Breeze SDK allows for embedding our payment page on your front-end with little to no configuration required. - [Embedding iframe Guidelines](https://docs.breeze.com/docs/embedding-iframe-guidelines.md) - [Handling iframe postMessage events on the parent frame](https://docs.breeze.com/docs/handling-iframe-postmessage-events-on-the-parent-frame.md) - [Embedding Mobile App Guidelines](https://docs.breeze.com/docs/embedding-mobile-app-guidelines.md) - [Configuring payment methods on Breeze from client](https://docs.breeze.com/docs/configuring-payment-methods-on-breeze.md) - [Customized UI for Payment pages](https://docs.breeze.com/docs/customised-ui-for-payment-pages.md) - [Refund](https://docs.breeze.com/docs/refund.md) - Payout (Payout Page) - [Payout Page Overview](https://docs.breeze.com/docs/payout-page-overview.md) - [Quick Start: Create and Test a Payout Page](https://docs.breeze.com/docs/payout-page-quick-start.md) - [Multi-currency Payouts](https://docs.breeze.com/docs/multi-currency-payouts.md) - [Payout Page Statuses and Sub-Statuses](https://docs.breeze.com/docs/payout-page-statuses.md) - [Releasing a Payout Page](https://docs.breeze.com/docs/payout-page-release-flow.md) - [Canceling a Payout Page](https://docs.breeze.com/docs/payout-page-cancellation.md) - [Webhook Events for Payout Pages](https://docs.breeze.com/docs/payout-page-webhooks.md) - [Handling Iframe postMessage events on the parent frame](https://docs.breeze.com/docs/handling-payout-iframe-postmessage-events-on-the-parent-frame.md) - [Headless Payout](https://docs.breeze.com/docs/headless-payout.md) - [Configuring payout methods on Breeze from client](https://docs.breeze.com/docs/configuring-payout-methods-on-breeze-from-client.md) - [Sandbox: Advance Payout Page Status](https://docs.breeze.com/docs/payout-page-sandbox-confirm.md) - Customer - [Customer Overview](https://docs.breeze.com/docs/quick-start-customer.md) - [Merchant trust signals](https://docs.breeze.com/docs/merchant-trust-signals.md) - Know Your Customer (KYC) - [KYC Overview](https://docs.breeze.com/docs/kyc-overview.md) - [Option 1: Onboarding a Customer with KYC Data](https://docs.breeze.com/docs/onboarding-a-customer-with-kyc-data.md) - [Option 2: KYC Webhook](https://docs.breeze.com/docs/kyc-webhook.md) - [Option 3: Headless KYC](https://docs.breeze.com/docs/option-3-headless-kyc.md) - [Headless KYC Tier 3 Escalation](https://docs.breeze.com/docs/headless-kyc-tier-3-escalation.md): When and how to handle a customer's KYC tier escalation - [KYC Tiers & Fields](https://docs.breeze.com/docs/kyc-tiers-fields.md) - [Products](https://docs.breeze.com/docs/product.md) - Subscription - [Subscription Overview](https://docs.breeze.com/docs/subscription-overview.md) - [Choosing a Subscription Type](https://docs.breeze.com/docs/subscription-decision-guide.md) - [Scheduled & Free Trial](https://docs.breeze.com/docs/subscription-scheduled-free-trial-overview.md) - [Pricing Phases](https://docs.breeze.com/docs/subscription-phases-overview.md) - [Discounted Trial (Deprecated)](https://docs.breeze.com/docs/subscription-discounted-trial-overview.md) - [Quick Start (Subscription)](https://docs.breeze.com/docs/quick-start-subscription.md) - Webhook Notifications - [Subscription Events](https://docs.breeze.com/docs/subscription-events.md) - [Invoice Events](https://docs.breeze.com/docs/invoice-events.md) - Webhooks - [Webhooks Overview](https://docs.breeze.com/docs/webhooks-overview.md) - [Webhook Signature Verification](https://docs.breeze.com/docs/webhook-signature-verification.md) - [Webhook Event Reference](https://docs.breeze.com/docs/webhook-event-reference.md) - [Statements](https://docs.breeze.com/docs/statements.md) - [Disputes](https://docs.breeze.com/docs/disputes.md) - [WooCommerce Integration](https://docs.breeze.com/docs/woocommerce-integration.md) - Risk - [Breeze Risk JS SDK](https://docs.breeze.com/docs/risk-js-sdk.md): Client-Side JavaScript SDK for Breeze Payments - [Query risk status by email](https://docs.breeze.com/docs/query-risk-status-by-email.md): Query the current risk status of a user. - Liquidation Address - [Overview](https://docs.breeze.com/docs/liquidation-address-overview.md) - [QuickStart](https://docs.breeze.com/docs/liquidation-address-quickstart.md) - [Core Concept](https://docs.breeze.com/docs/core-concept.md) - [Webhooks](https://docs.breeze.com/docs/liquidation-address-webhooks.md) - [Supported Crypto Networks & Tokens](https://docs.breeze.com/docs/supported-crypto-networks-and-tokens.md) ## Guides: Errors & Troubleshooting - [Error Reference](https://docs.breeze.com/docs/error-reference.md) - [Debugging Payment Failures](https://docs.breeze.com/docs/payment-failure-debugging.md) ## Guides: Merchant Settlement Guide - [Your Balances](https://docs.breeze.com/docs/your-balances.md) - [Flow of Funds](https://docs.breeze.com/docs/flow-of-funds.md) - [Minimum Balance](https://docs.breeze.com/docs/minimum-balance.md) - [Getting Started](https://docs.breeze.com/docs/getting-started.md) - [Every Settlement Day](https://docs.breeze.com/docs/every-settlement-day.md) - [Dashboard Fields](https://docs.breeze.com/docs/dashboard-fields.md) - [Settlement FAQ](https://docs.breeze.com/docs/settlement-faq.md) ## Guides: Merchant Dashboard Guide - [Reports](https://docs.breeze.com/docs/reports.md) - [Analytics](https://docs.breeze.com/docs/analytics.md) - [Customer Blocklist](https://docs.breeze.com/docs/customer-blocklist.md) - [Dispute Evidence](https://docs.breeze.com/docs/dispute-evidence.md) - [Two-Factor Authentication](https://docs.breeze.com/docs/two-factor-authentication.md) ## Guides: MCP Server - [Connect Breeze to your AI assistant (MCP)](https://docs.breeze.com/docs/mcp.md) ## Guides: Direct Payment API - [Direct Payment Integration Guide](https://docs.breeze.com/docs/direct-payment-integration-guide.md) ## API Reference: Breeze API - Balances - [Get pay-in balance](https://docs.breeze.com/reference/getpayinbalance.md): Pay-in funds not yet settled to you, and how they split across upcoming settlements. Reads one pay-in account: `accountType` when given, otherwise your main pay-in account (`payIn` for most… - [Get payout balance](https://docs.breeze.com/reference/getpayoutbalance.md): Your payout wallet and what it can fund. - `payoutWalletBalanceMinor`: funds in your payout wallet, read from the chain. - `inProcessingMinor`: payouts in progress (amount + fee) on the wallet's… - Customers - [Create a customer](https://docs.breeze.com/reference/createcustomer.md): Creates a new customer for the authenticated merchant. - [Get a customer by query](https://docs.breeze.com/reference/getcustomerbyquery.md): Retrieves a customer by reference ID or email. - [Get a customer by ID](https://docs.breeze.com/reference/getcustomerbyid.md) - [Update a customer](https://docs.breeze.com/reference/updatecustomer.md) - [Offboard a customer](https://docs.breeze.com/reference/offboardcustomer.md): Restricts the payment and payout methods available to a customer. - Disputes - [List disputes](https://docs.breeze.com/reference/listdisputes.md) - [Simulate a chargeback (sandbox)](https://docs.breeze.com/reference/simulatesandboxdispute.md): Creates a simulated Visa chargeback with reason code 10.4 (fraud) on one of your sandbox payment pages. Only sandbox merchants can call this endpoint, and each payment can carry at most one dispute.… - Fraud Reports - [List fraud reports](https://docs.breeze.com/reference/listfraudreports.md) - [Get a fraud report by ID](https://docs.breeze.com/reference/getfraudreport.md) - Headless KYC - [Get a KYC request by customer reference ID](https://docs.breeze.com/reference/getheadlesskycbycustomerreferenceid.md): **Note:** This endpoint is only available to merchants configured by the Breeze team. Please reach out to the Breeze team to find out more. - [Get a KYC request by ID](https://docs.breeze.com/reference/getheadlesskycbyid.md): **Note:** This endpoint is only available to merchants configured by the Breeze team. Please reach out to the Breeze team to find out more. - [Submit KYC for a customer (via image upload)](https://docs.breeze.com/reference/submitheadlesskycwithimageupload.md): Submits KYC data for a customer on behalf of the merchant. Only TIER_2 is supported. Idempotent on customerReferenceId. This API spec details the request body for the **`multipart/form-data` content… - [Submit KYC for a customer (via image URL)](https://docs.breeze.com/reference/submitheadlesskycwithimageurl.md): Submits KYC data for a customer on behalf of the merchant. Only TIER_2 is supported. Idempotent on customerReferenceId. This API spec details the request body for the **`application/json` content… - [Submit a proof of address for a customer (via document URL)](https://docs.breeze.com/reference/submitheadlesskycproofofaddresswithurl.md): Submits a proof-of-address document for a customer who has already been submitted for KYC. The document is the only data to supply: the name and address sent for verification are read back from the… - [Submit a proof of address for a customer (via document upload)](https://docs.breeze.com/reference/submitheadlesskycproofofaddresswithupload.md): Submits a proof-of-address document for a customer who has already been submitted for KYC. The document is the only data to supply: the name and address sent for verification are read back from the… - [Initiate Tier 3 verification for a KYC request](https://docs.breeze.com/reference/initiateheadlesskyctier3.md): Starts the user-facing part of a Tier 3 KYC request and returns the request with its `actionLink`: a hosted verification link the end user must open to complete the Tier 3 identity checks. Tier 3… - Headless Payout - [Create a headless payout](https://docs.breeze.com/reference/createheadlesspayout.md): Creates a payout for a KYC-verified customer in a single API call. Validates the customer has active TIER_2 KYC, creates or reuses the destination bank account, and initiates the payout. Idempotent… - Invoices - [Get an invoice by ID](https://docs.breeze.com/reference/getinvoice.md) - Liquidation Addresses - [Create a liquidation address](https://docs.breeze.com/reference/createliquidationaddress.md): Creates a reusable on-chain address that automatically converts and settles any funds it receives to the configured destination chain, currency, and address. - [List liquidation addresses](https://docs.breeze.com/reference/listliquidationaddresses.md): Returns a cursor-paginated list of the merchant's liquidation addresses. - [Get a liquidation address by ID](https://docs.breeze.com/reference/getliquidationaddress.md) - [List liquidation address transactions](https://docs.breeze.com/reference/listliquidationaddresstransactions.md): Returns a cursor-paginated list of deposit transactions for a liquidation address. - [Get a liquidation address transaction by ID](https://docs.breeze.com/reference/getliquidationaddresstransaction.md) - Offramp - [Create an offramp request](https://docs.breeze.com/reference/createofframprequest.md): Creates a new offramp request. Deprecated in favor of Payout Pages. - [Get an offramp request by ID](https://docs.breeze.com/reference/getofframprequest.md) - [Cancel an offramp request](https://docs.breeze.com/reference/cancelofframprequest.md) - [Release an offramp request](https://docs.breeze.com/reference/releaseofframprequest.md) - Direct Payment - [Create a payment](https://docs.breeze.com/reference/creategatewaypayment.md): Create and authorize a payment. For merchant-calculated tax, first call [Get tax rate](https://docs.breeze.com/reference/getmerchanttaxrate) with the pre-tax amount and customer location. Then set… - [Get a payment](https://docs.breeze.com/reference/getgatewaypayment.md): Retrieve current status and details of an S2S payin. > **Base URL** — call this on the default `api.breeze.cash` host, **not** the `secure.breeze.cash` / `secure-sandbox.breeze.cash` host used to… - [Resume payment after merchant 3DS](https://docs.breeze.com/reference/resumegatewaypaymentauthentication.md): Resume a payment that returned `status: ACTION_REQUIRED` with `nextAction.type: AUTHENTICATION_REQUIRED`. Submit the 3DS results obtained from your merchant-provided 3DS provider to complete… - [List a customer's saved payment methods](https://docs.breeze.com/reference/listgatewaycustomerpaymentmethods.md): List the active saved cards stored on a Breeze customer (`cus_*`). Each entry includes display metadata plus the opaque `saved_*` identifier you re-submit as a `SAVED_CARD` payment method on `POST… - [Remove a customer's saved payment method](https://docs.breeze.com/reference/deletegatewaycustomerpaymentmethod.md): Remove (deactivate) a saved card stored on a Breeze customer (`cus_*`). The card is soft-deleted: it stops appearing in the customer's saved payment methods and can no longer be re-submitted as a… - Payment Pages - [Create a payment page](https://docs.breeze.com/reference/createpaymentpage.md) - [Get a payment page by ID](https://docs.breeze.com/reference/getpaymentpage.md) - [Expire a payment page](https://docs.breeze.com/reference/expirepaymentpage.md): Marks an open payment page as expired so it can no longer accept payments. - [Initiate a refund](https://docs.breeze.com/reference/initiaterefund.md): Initiates a refund for a succeeded payin (payment page). > **Sandbox limitation** — pages manually marked paid via the sandbox "Mark as Paid" button have no captured payment to reverse, so refunds… - [Get a refund by ID](https://docs.breeze.com/reference/getrefund.md) - [Get all payment attempts for a specific page ID](https://docs.breeze.com/reference/getallpaymentattempts.md) - [List payment pages](https://docs.breeze.com/reference/listpaymentpages.md): Returns a paginated list of payment pages. Prefer cursor pagination: pass the nextCursorToken from the previous response as cursorToken to fetch the next page; when hasMore is false you have reached… - Payout Pages - [Create a payout page](https://docs.breeze.com/reference/createpayoutpage.md) - [Get a payout page by ID](https://docs.breeze.com/reference/getpayoutpage.md) - [Release a payout page](https://docs.breeze.com/reference/releasepayoutpage.md): Releases a payout page for processing. - [Cancel a payout page](https://docs.breeze.com/reference/cancelpayoutpage.md) - [Sandbox confirm a payout page](https://docs.breeze.com/reference/sandboxconfirmpayoutpage.md): Confirms a payout page in the sandbox environment, transitioning it to the specified status. - [List payout pages](https://docs.breeze.com/reference/getpayoutpagehistory.md): Returns a paginated list of payout pages. Use the nextCursorToken from the response as cursorToken in the next request to page through results. When hasMore is false, you have reached the last page. - Products - [Create a product](https://docs.breeze.com/reference/createproduct.md) - [List products](https://docs.breeze.com/reference/listproducts.md): Returns a paginated list of products with their prices. Use the nextCursorToken from the response as cursorToken in the next request to page through results. When hasMore is false, you have reached… - [Get a product by ID](https://docs.breeze.com/reference/getproduct.md) - [Create a price for a product](https://docs.breeze.com/reference/createproductprice.md) - Risk - [Get the current risk status for a customer email](https://docs.breeze.com/reference/getriskstatus.md) - Statements - [List statements](https://docs.breeze.com/reference/liststatements.md) - [Download a statement](https://docs.breeze.com/reference/downloadstatement.md): Returns a signed URL to download the statement file. - Subscriptions - [Create a subscription](https://docs.breeze.com/reference/createsubscription.md) - [List subscriptions](https://docs.breeze.com/reference/listsubscriptions.md) - [Get a subscription by ID](https://docs.breeze.com/reference/getsubscription.md) - [Cancel a subscription](https://docs.breeze.com/reference/cancelsubscription.md) - [Get a subscription by client reference ID](https://docs.breeze.com/reference/getsubscriptionbyclientreferenceid.md) - Tax - [Get tax rate for merchant](https://docs.breeze.com/reference/getmerchanttaxrate.md): Returns the tax rate and amount to collect for a given amount, tax source, and currency. Uses the merchant's configured product category. Use the recommended zipcode query object where possible; use… - Webhooks - [Payment succeeded](https://docs.breeze.com/reference/webhook_payment_succeeded.md): Sent when a hosted payment page reaches the PAID state. - [Payout page status update](https://docs.breeze.com/reference/webhook_payout_page_status_update.md): Sent when a payout page's status changes. - [Refund status update](https://docs.breeze.com/reference/webhook_refund_status_update.md): Sent when a payin refund's status changes.