QuickStart

This guide walks through creating a Liquidation Address, funding it, and observing a settlement end to end. It assumes you already have Breeze API credentials.

1. Create a Liquidation Address

Define a source (what the address accepts) and a destination (where settled funds go), then call the create endpoint.

curl -X POST https://api.breeze.com/v1/liquidation_addresses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "chain": "EVM",
    "currency": "USDC",
    "destinationChain": "SOLANA",
    "destinationCurrency": "USDC",
    "destinationAddress": "YOUR_DESTINATION_WALLET_ADDRESS",
    "label": "Storefront deposits"
  }'

Field	Required	Description
`chain`	Yes	Source network. A specific network (e.g. `ETHEREUM`), or `EVM` for any supported EVM network.
`currency`	No	Restricts deposits to a single currency. Omit to accept any supported currency.
`destinationChain`	Yes	Network funds settle on.
`destinationCurrency`	Yes	Currency funds are converted into.
`destinationAddress`	Yes	Address that receives settled funds.
`label`	No	Free-text identifier (max 256 chars).

The response includes the persistent address to fund:

{
  "id": "liqaddr_...",
  "chain": "ETHEREUM",
  "currency": "USDC",
  "destinationChain": "SOLANA",
  "destinationCurrency": "USDC",
  "destinationAddress": "YOUR_DESTINATION_WALLET_ADDRESS",
  "address": "0xPERSISTENT_DEPOSIT_ADDRESS",
  "status": "ACTIVE",
  "label": "Storefront deposits"
}

2. Fund the address

Send funds from any wallet to the returned address on the source network. The address is persistent — you (or your customers) can deposit into it any number of times.

Breeze monitors the address on-chain and detects deposits automatically. No additional API call is required for normal deposits.

3. Track the transaction

Each deposit becomes a Liquidation Address Transaction. List the transactions for an address:

curl https://api.breeze.com/v1/liquidation_addresses/{id}/transactions \
  -H "Authorization: Bearer YOUR_API_KEY"

Or fetch a single transaction:

curl https://api.breeze.com/v1/liquidation_addresses/{id}/transactions/{txId} \
  -H "Authorization: Bearer YOUR_API_KEY"

The transaction's status advances from DEPOSIT_CONFIRMED through conversion and settlement to COMPLETED. See Core Concepts for the full lifecycle.

4. Receive settlement updates

Rather than polling, subscribe to webhooks to be notified as each transaction's status changes. See Webhooks.

Managing addresses

# List your liquidation addresses
curl https://api.breeze.com/v1/liquidation_addresses \
  -H "Authorization: Bearer YOUR_API_KEY"

# Retrieve a single address
curl https://api.breeze.com/v1/liquidation_addresses/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"