Quick Start (payout)

1. Create a Withdrawal Request

Send a POST request to the Breeze Payout API with the basic parameters. You can quickly test this using a command-line tool like cURL:

curl -X POST 'https://api.breeze.cash/v1/payouts' \
  -u "YOUR_API_KEY:" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "amount": 5000,
    "currency": "USD",
    "clientReferenceId": "payout-<your-unique-id>",
    "email": "[email protected]",
    "successReturnUrl": "https://your-domain.com/payout-complete",
    "failReturnUrl": "https://your-domain.com/payout-aborted"
  }'

A successful response will look like this:

{
  "status": "SUCCEEDED",
  "data": {
    "id": "payout_abc123xyz",
    "url": "https://pay.breeze.cash/payout_abc123xyz",
    ...
  }
}

• data.id: A unique identifier for tracking this payout transaction on Breeze’s side.
• data.url: The URL to redirect your customer to, where they’ll securely provide payout details and complete the withdrawal.

2. Redirect the User

Once you have the data.url, simply redirect the user’s browser to this URL. Breeze will handle the secure collection of payout information (bank account, debit card, crypto wallet) and required KYC verification.

3. Handle Webhooks

After the payout succeeds or fails, Breeze sends a webhook notification to your server or application. Here’s an example webhook payload:

{
  "type": "PAYOUT_STATUS_UPDATE",
  "data": {
    "payoutId": "payout_abc123xyz",
    "status": "SUCCEEDED",
    "clientReferenceId": "payout-<your-unique-id>",
    ...
  },
  "signature": "webhook_payload_signature"
}

• Set up an endpoint (e.g., /webhook) on your server or app to accept the webhook JSON via a POST request. Breeze will send payout notifications to the same webhook endpoint you’ve configured for payment notifications.
• Use the webhook data to update your internal records, marking the payout as successful (or failed based on the status).

Next Steps

• Secure Your Webhook: Validate webhook signatures to ensure they come from Breeze.
• Go Live: After thorough testing, switch to production credentials to process real-world payouts.