Payout Page Statuses and Sub-Statuses

A payout page moves through a set of statuses from creation to completion. These statuses (and sub-statuses) let you track where the payout is in its lifecycle and handle events appropriately.

Statuses

Status

Meaning

Example Trigger

CREATED

Payout page has been created successfully.

Merchant calls Create Payout Page API.

PENDING

Awaiting action before processing can start.

Customer has opened the payout page but hasn’t finished all steps.

PROCESSING

Breeze is interacting with third-party providers to send funds.

Funds are being routed through bank or blockchain.

PROCESSED

  • Funds have been successfully sent to the customer’s crypto wallet, or
  • accepted by the bank and are in transit, or
  • the payout is in a transitional state leading toREFUNDED.
  • Crypto transaction confirmed, or
  • bank partner accepted the transfer, or
  • bank partner responded that payout cannot be processed and will be refunded.

REFUNDED

Funds rejected by third-party provider, and credited back to merchant's payout balance.

Bank account closed or details invalid.

CANCELLED

Payout page cancelled by the merchant before processing.

Merchant calls Cancel Payout Page API.

EXPIRED

Payout page was never processed and is no longer available.

Customer did not act before expiry time.

REJECTED

Soon-to-be introduced status
Payout request is rejected by Breeze

Required risk checks are not met.

flowchart TD
    A[CREATED] --> B[PENDING]
    B -.-> H[REJECTED*]
		B --> C[PROCESSING]
    C --> D[PROCESSED]
    D -.-> E[REFUNDED]
    B --> F[CANCELLED]
    B --> G[EXPIRED]

Sub-Statuses (for PENDING status only)

While in the PENDING status, a payout page can be in one of the following sub-statuses:

Sub-StatusMeaningExample Trigger
PENDING_USER_CONFIRMATIONWaiting for the customer to provide payout method and details.Customer has opened the page but hasn’t submitted payout info yet.
PENDING_USER_ONBOARDINGWaiting for the customer to complete KYC verification (new-to-Breeze only).Customer is routed to identity verification flow.
PENDING_INTERNAL_REVIEWWaiting for internal checks to be completed.Risk/compliance checks in progress.
PENDING_MERCHANT_RELEASEWaiting for merchant to call the Release Payout Page API.Merchant created the page with manual release setting enabled.