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.

For webhook payload examples for each status change, see Webhook Events for Payout Pages.

Statuses

StatusMeaningExample Trigger
CREATEDPayout page has been created successfully.Merchant calls Create Payout Page API.
PENDINGAwaiting action before processing can start.Customer has opened the payout page but hasn’t finished all steps.
PROCESSINGBreeze 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.
REFUNDEDFunds rejected by third-party provider, and credited back to merchant's payout balance.Bank account closed or details invalid.
CANCELEDPayout page canceled by the merchant before processing.Merchant calls Cancel Payout Page API.
EXPIREDPayout page was never processed and is no longer available.Customer did not act before expiry time.
REJECTEDSoon-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[CANCELED]
    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_MERCHANT_RELEASEWaiting for merchant to call the Release Payout Page API.Merchant created the page with manual release setting enabled.
CustomerPENDING_USER_CONFIRMATION

Customer has opened the payout page but hasn't submitted their payout method and details yet.

Webhook: PAYOUT_PAGE_PENDING_STATUS_UPDATE · pendingStatus: PENDING_USER_CONFIRMATION

CustomerPENDING_USER_ONBOARDINGfirst payout only

Customer is completing KYC verification — only applies on their first payout with Breeze.

Webhook: PAYOUT_PAGE_PENDING_STATUS_UPDATE · pendingStatus: PENDING_USER_ONBOARDING

MerchantPENDING_MERCHANT_RELEASEMANUAL releaseMethod only

Waiting for merchant to call POST /v1/payout_pages/:id/release.

Webhook: PAYOUT_PAGE_PENDING_STATUS_UPDATE · pendingStatus: PENDING_MERCHANT_RELEASE

Not all four sub-statuses appear for every payout — node 2 fires on first payout only, node 4 only when releaseMethod is MANUAL.



Did this page help you?