Releasing a Payout Page

When creating a Payout Page, you can specify the release method with the releaseMethod field in the request payload.

There are two options:

Release MethodDescription
MANUALMerchant must explicitly release the payout page via API
AUTOMATICPayout page is released automatically after customer submission

Manual Release

If the releaseMethod is set to MANUAL:

  1. The customer submits payout details and completes KYC verification (if required)
  2. The Payout Page enters status PENDING with sub-status PENDING_MERCHANT_RELEASE
  3. Breeze sends a webhook event notifying you that the page is waiting for release
  4. The merchant must call the Payout Page Release endpoint to start processing

Example request:

curl -X POST \
    https://api.breeze.cash/v1/payout_pages/payout_page_404aaaa1c9ced891/release \
    -H 'content-type: application/json' \
    -H 'Authorization: Basic <Base64 encoded API key>'
ℹ️

If you need some manual in-person review for a payout that would take a longer time, it would be better to do so before reaching this manual release step

Automatic Release

If the releaseMethod is set to AUTOMATIC:

  1. The customer submits payout details and completes KYC verification (if required)
  2. The payout page is immediately released for processing
  3. Breeze sends a webhook event where the payout page status is PROCESSING