The Cancel Payout Page endpoint allows a merchant to cancel a payout page, but only while the status is CREATED or PENDING.

Once the payout page has transitioned to PROCESSING, PROCESSED, or REFUNDED, it can no longer be cancelled.

When you might cancel a payout page

Some common reasons to cancel:

• The customer requested to stop the payout.
• The payout amount or details were entered incorrectly.
• The merchant identified the payout as fraudulent or high-risk.
• The merchant wants to issue funds through another channel.

Cancel a payout page

Send the following request to cancel a payout page:

curl -X POST \
    'https://api.breeze.cash/v1/payout_pages/:payoutPageId/cancel?livemode=false' \
    -H 'Authorization: Basic <base64 encoded API key>'

Replace the placeholders:

• :payoutPageId: ID of the payout page you want to cancel.
• <Base64 encoded API key>: your Breeze API key, encoded in Base64.

Automatic Expiration

All payout pages that have not yet started processing will automatically expire after 7 days from creation.

• Expired payout pages will transition to status EXPIRED
• Breeze will send a webhook event when this happens
• Expired payout pages cannot be resumed or processed - merchants must create a new payout page if needed

If a merchant wants to close a pending payout page earlier than 7 days, they can call the Cancel Payout Page API. This will immediately transition the payout page to status CANCELLED.