In sandbox mode, you can manually advance a payout page to PROCESSED or REFUNDED using the sandbox_confirm endpoint — without waiting for real fund movement.

⚠️
This endpoint only works in sandbox mode. It will return an error if called with a live-mode API key.

Prerequisites

The customer must have clicked Confirm on the payout page before you can advance the status.
You need the payout page id returned when you created the payout page.

Advance the Status

Send a POST request with the target status:

curl -X POST 'https://api.breeze.cash/v1/payout_pages/PAYOUT_PAGE_ID/sandbox_confirm?livemode=false' \
  -u "YOUR_API_KEY:" \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "PROCESSED"
  }'

Replace the placeholders:

PAYOUT_PAGE_ID: the id returned when you created the payout page (e.g. payout_page_562315443de70f4d)

Status options:

Status	Description
`PROCESSED`	Marks the payout as successfully processed
`REFUNDED`	Marks the payout as refunded. If the payout page is not yet `PROCESSED`, it will automatically advance through `PROCESSED` first

Response

A successful response returns the payout page ID:

{
  "status": "SUCCEEDED",
  "data": {
    "id": "payout_page_562315443de70f4d"
  }
}

API Reference — See the full parameter reference at Sandbox Confirm a Payout Page.

Error codes — For a complete list of errors returned by the payout page endpoints, see the Error Reference.

Webhooks — For webhook events fired during status transitions, see the Payout Page Webhooks guide.