Quick Start (customer offramp)

Breeze’s Customer Offramp lets you send USDC to your customers while seamlessly converting it into USD and delivering it to their bank account or debit card—securely, compliantly, and with minimal integration.

1. Create an Offramp Request

Send a POST request to the Breeze Offramp 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/offramp' \
  -u "YOUR_API_KEY:" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "network": "polygon",
    "token": "usdc",
    "amount": 5000,
    "clientReferenceId": "offramp-<your-unique-id>",
    "email": "[email protected]",
    "successReturnUrl": "https://your-domain.com/offramp-complete",
    "failReturnUrl": "https://your-domain.com/offramp-aborted",
    "customer": {
      "country": "US"
    }
  }'

A successful response will look like this:

{
  "status": "SUCCEEDED",
  "data": {
    "id": "ofrprq_abc123xyz",
    "url": "https://offramp.breeze.cash/ofrprq_abc123xyz",
    ...
  }
}

• data.id: Unique identifier for this offramp transaction.
• data.url: The Breeze-hosted page where your customer will complete KYC and submit banking info.

2. Redirect the User

Once you receive the data.url, redirect your customer’s browser to that URL. Breeze will:

• Verify KYC and collect bank or debit card details.
• Execute fiat payout once KYC is approved.
• Transfer USDC from Breeze’s pooled wallet to fulfil the payout on behalf of your platform.

Note: USDC is not sent directly to Breeze. Breeze executes the crypto transfer on your behalf as the MoR.

3. Handle Webhooks

Breeze notifies you of each stage via webhooks—including KYC events, crypto execution, and final payout status. Example webhook payload:

{
  "type": "OFFRAMP_STATUS_UPDATE",
  "data": {
    "id": "ofrprq_abc123xyz",
    "status": "SUCCEEDED",
    "clientReferenceId": "offramp-<your-unique-id>",
    ...
  },
  "signature": "webhook_payload_signature"
}

• Set up a POST endpoint (e.g., /webhook) to receive updates.
• Use the webhook to track KYC outcome, crypto settlement, and payout result.

Next Steps

• Secure Your Webhook: Validate webhook signatures to confirm authenticity.
• Test the Full Flow: Simulate all stages in a sandbox environment.
• Go Live: Switch to production keys and start enabling real offramp flows for your users.