Breeze.cash Liquidation Addresses API

The Liquidation Addresses API from Breeze.cash — 4 operation(s) for liquidation addresses.

Operations 5

POST /v1/liquidation_addresses Create a liquidation address #
GET /v1/liquidation_addresses List liquidation addresses #
GET /v1/liquidation_addresses/{id} Get a liquidation address by ID #
GET /v1/liquidation_addresses/{id}/transactions List liquidation address transactions #
GET /v1/liquidation_addresses/{id}/transactions/{txId} Get a liquidation address transaction by ID #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/breezecash:breezecash-liquidation-addresses-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

breezecash-liquidation-addresses-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Breeze Liquidation Addresses API
  version: 1.0.0
  description: Breeze payment processing API
  contact:
    email: support@breeze.cash
    url: https://docs.breeze.cash
servers:
- url: https://api.breeze.cash
  description: Breeze API
- url: https://secure.breeze.cash
  description: Breeze Direct Payment API (production)
- url: https://secure-sandbox.breeze.cash
  description: Breeze Direct Payment API (sandbox)
security:
- basicAuth: []
tags:
- name: Liquidation Addresses
paths:
  /v1/liquidation_addresses:
    post:
      operationId: createLiquidationAddress
      tags:
      - Liquidation Addresses
      summary: Create a liquidation address
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The created liquidation address
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/CreateLiquidationAddressResponse'
                required:
                - status
                - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      description: Creates a reusable on-chain address that automatically converts and settles any funds it receives to the configured destination chain, currency, and address.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLiquidationAddressRequest'
    get:
      operationId: listLiquidationAddresses
      tags:
      - Liquidation Addresses
      summary: List liquidation addresses
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: A list of liquidation addresses
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/ListLiquidationAddressesResponse'
                required:
                - status
                - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      description: Returns a cursor-paginated list of the merchant's liquidation addresses.
      parameters:
      - name: pagination
        in: query
        required: false
        schema:
          type: object
          default:
            limit: 20
            type: cursor
          properties:
            offset:
              type: number
              minimum: 0
            limit:
              type: number
              default: 20
              minimum: 1
              maximum: 50
            cursorToken:
              type: string
          additionalProperties: false
  /v1/liquidation_addresses/{id}:
    get:
      operationId: getLiquidationAddress
      tags:
      - Liquidation Addresses
      summary: Get a liquidation address by ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The liquidation address
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/GetLiquidationAddressResponse'
                required:
                - status
                - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Liquidation address ID
  /v1/liquidation_addresses/{id}/transactions:
    get:
      operationId: listLiquidationAddressTransactions
      tags:
      - Liquidation Addresses
      summary: List liquidation address transactions
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: A list of liquidation address transactions
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/ListLiquidationAddressTransactionsResponse'
                required:
                - status
                - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      description: Returns a cursor-paginated list of deposit transactions for a liquidation address.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Liquidation address ID
      - name: pagination
        in: query
        required: false
        schema:
          type: object
          default:
            limit: 20
            type: cursor
          properties:
            offset:
              type: number
              minimum: 0
            limit:
              type: number
              default: 20
              minimum: 1
              maximum: 50
            cursorToken:
              type: string
          additionalProperties: false
  /v1/liquidation_addresses/{id}/transactions/{txId}:
    get:
      operationId: getLiquidationAddressTransaction
      tags:
      - Liquidation Addresses
      summary: Get a liquidation address transaction by ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The liquidation address transaction
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/GetLiquidationAddressTransactionResponse'
                required:
                - status
                - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Liquidation address ID
      - name: txId
        in: path
        required: true
        schema:
          type: string
        description: Liquidation address transaction ID
components:
  schemas:
    ListLiquidationAddressTransactionsResponse:
      type: object
      required:
      - transactions
      properties:
        transactions:
          type: array
          items:
            $schema: http://json-schema.org/draft-07/schema#
            type: object
            properties:
              id:
                type: string
              createdAt:
                type: number
              updatedAt:
                type: number
              liquidationAddressId:
                type: string
              merchantId:
                type: string
              livemode:
                type: boolean
              status:
                type: string
                enum:
                - PENDING_DEPOSIT_VALIDATION
                - DEPOSIT_CONFIRMED
                - TRADE_PENDING
                - TRADE_EXECUTING
                - SETTLEMENT_PENDING
                - COMPLETED
                - FAILED
                - CANCELLED
              depositTransactionHash:
                type: string
              depositAmount:
                type: string
              depositCurrency:
                type: string
                enum:
                - USDC
                - USDCE
                - USDBC
                - USDT
                - EURC
                - DAI
                - BUSD
                - BTC
                - ETH
                - BNB
                - MATIC
                - POL
                - AVAX
                - SOL
                - TRX
                - KAP
                - ARB
                - CBBTC
                - PYUSD
                - SNS
                - HONEY
              depositNetwork:
                type: string
                enum:
                - ETHEREUM
                - OPTIMISM
                - BINANCE
                - POLYGON
                - ARBITRUM
                - AVALANCHE
                - SOLANA
                - TRON
                - BASE
                - BITCOIN
              depositConfirmedAt:
                type: number
              fromAddress:
                type: string
              settlementAmount:
                type: string
              settlementCurrency:
                type: string
                enum:
                - USDC
                - USDCE
                - USDBC
                - USDT
                - EURC
                - DAI
                - BUSD
                - BTC
                - ETH
                - BNB
                - MATIC
                - POL
                - AVAX
                - SOL
                - TRX
                - KAP
                - ARB
                - CBBTC
                - PYUSD
                - SNS
                - HONEY
              settlementNetwork:
                type: string
                enum:
                - ETHEREUM
                - OPTIMISM
                - BINANCE
                - POLYGON
                - ARBITRUM
                - AVALANCHE
                - SOLANA
                - TRON
                - BASE
                - BITCOIN
              settlementAddress:
                type: string
              settlementTransactionHash:
                type: string
              settlementConfirmedAt:
                type: number
            required:
            - liquidationAddressId
            - merchantId
            - livemode
            - status
            - depositTransactionHash
            - depositAmount
            - depositCurrency
            - depositNetwork
            definitions: {}
        cursor:
          type: object
          description: Cursor for the next page. Absent when there are no more results.
          properties:
            createdAt:
              type: integer
              description: Creation timestamp (Unix milliseconds) of the last item in the current page.
    GetLiquidationAddressTransactionResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        createdAt:
          type: number
        updatedAt:
          type: number
        liquidationAddressId:
          type: string
        merchantId:
          type: string
        livemode:
          type: boolean
        status:
          type: string
          enum:
          - PENDING_DEPOSIT_VALIDATION
          - DEPOSIT_CONFIRMED
          - TRADE_PENDING
          - TRADE_EXECUTING
          - SETTLEMENT_PENDING
          - COMPLETED
          - FAILED
          - CANCELLED
        depositTransactionHash:
          type: string
        depositAmount:
          type: string
        depositCurrency:
          type: string
          enum:
          - USDC
          - USDCE
          - USDBC
          - USDT
          - EURC
          - DAI
          - BUSD
          - BTC
          - ETH
          - BNB
          - MATIC
          - POL
          - AVAX
          - SOL
          - TRX
          - KAP
          - ARB
          - CBBTC
          - PYUSD
          - SNS
          - HONEY
        depositNetwork:
          type: string
          enum:
          - ETHEREUM
          - OPTIMISM
          - BINANCE
          - POLYGON
          - ARBITRUM
          - AVALANCHE
          - SOLANA
          - TRON
          - BASE
          - BITCOIN
        depositConfirmedAt:
          type: number
        fromAddress:
          type: string
        settlementAmount:
          type: string
        settlementCurrency:
          type: string
          enum:
          - USDC
          - USDCE
          - USDBC
          - USDT
          - EURC
          - DAI
          - BUSD
          - BTC
          - ETH
          - BNB
          - MATIC
          - POL
          - AVAX
          - SOL
          - TRX
          - KAP
          - ARB
          - CBBTC
          - PYUSD
          - SNS
          - HONEY
        settlementNetwork:
          type: string
          enum:
          - ETHEREUM
          - OPTIMISM
          - BINANCE
          - POLYGON
          - ARBITRUM
          - AVALANCHE
          - SOLANA
          - TRON
          - BASE
          - BITCOIN
        settlementAddress:
          type: string
        settlementTransactionHash:
          type: string
        settlementConfirmedAt:
          type: number
      required:
      - liquidationAddressId
      - merchantId
      - livemode
      - status
      - depositTransactionHash
      - depositAmount
      - depositCurrency
      - depositNetwork
      definitions: {}
    ListLiquidationAddressesResponse:
      type: object
      required:
      - addresses
      properties:
        addresses:
          type: array
          items:
            $schema: http://json-schema.org/draft-07/schema#
            type: object
            properties:
              id:
                type: string
              createdAt:
                type: number
              updatedAt:
                type: number
              merchantId:
                type: string
              livemode:
                type: boolean
              chain:
                type: string
                enum:
                - ETHEREUM
                - OPTIMISM
                - BINANCE
                - POLYGON
                - ARBITRUM
                - AVALANCHE
                - SOLANA
                - TRON
                - BASE
                - BITCOIN
                - EVM
              currency:
                type: string
                enum:
                - USDC
                - USDCE
                - USDBC
                - USDT
                - EURC
                - DAI
                - BUSD
                - BTC
                - ETH
                - BNB
                - MATIC
                - POL
                - AVAX
                - SOL
                - TRX
                - KAP
                - ARB
                - CBBTC
                - PYUSD
                - SNS
                - HONEY
              destinationChain:
                type: string
                enum:
                - ETHEREUM
                - OPTIMISM
                - BINANCE
                - POLYGON
                - ARBITRUM
                - AVALANCHE
                - SOLANA
                - TRON
                - BASE
                - BITCOIN
              destinationCurrency:
                type: string
                enum:
                - USDC
                - USDCE
                - USDBC
                - USDT
                - EURC
                - DAI
                - BUSD
                - BTC
                - ETH
                - BNB
                - MATIC
                - POL
                - AVAX
                - SOL
                - TRX
                - KAP
                - ARB
                - CBBTC
                - PYUSD
                - SNS
                - HONEY
              destinationAddress:
                type: string
              address:
                type: string
              status:
                type: string
                enum:
                - ACTIVE
                - DEACTIVATED
              label:
                type: string
            required:
            - merchantId
            - livemode
            - chain
            - destinationChain
            - destinationCurrency
            - destinationAddress
            - address
            - status
            definitions: {}
        cursor:
          type: object
          description: Cursor for the next page. Absent when there are no more results.
          properties:
            createdAt:
              type: integer
              description: Creation timestamp (Unix milliseconds) of the last item in the current page.
    CreateLiquidationAddressRequest:
      description: Liquidation address source and destination details
      type: object
      properties:
        chain:
          type: string
          enum:
          - ARBITRUM
          - ETHEREUM
          - OPTIMISM
          - POLYGON
          - BASE
          - BINANCE
          - SOLANA
          - EVM
        currency:
          type: string
          enum:
          - USDC
          - USDT
          - BUSD
          - DAI
          - ETH
          - BTC
          - SOL
        destinationChain:
          type: string
          enum:
          - ARBITRUM
          - ETHEREUM
          - OPTIMISM
          - POLYGON
          - BASE
          - BINANCE
          - SOLANA
        destinationCurrency:
          type: string
          enum:
          - USDC
          - USDT
        destinationAddress:
          type: string
        label:
          type: string
          maxLength: 256
      required:
      - chain
      - currency
      - destinationChain
      - destinationCurrency
      - destinationAddress
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - FAILED
        errorCode:
          type: string
        errorMessage:
          type: string
      required:
      - status
      - errorCode
      - errorMessage
    CreateLiquidationAddressResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        createdAt:
          type: number
        updatedAt:
          type: number
        merchantId:
          type: string
        livemode:
          type: boolean
        chain:
          type: string
          enum:
          - ETHEREUM
          - OPTIMISM
          - BINANCE
          - POLYGON
          - ARBITRUM
          - AVALANCHE
          - SOLANA
          - TRON
          - BASE
          - BITCOIN
          - EVM
        currency:
          type: string
          enum:
          - USDC
          - USDCE
          - USDBC
          - USDT
          - EURC
          - DAI
          - BUSD
          - BTC
          - ETH
          - BNB
          - MATIC
          - POL
          - AVAX
          - SOL
          - TRX
          - KAP
          - ARB
          - CBBTC
          - PYUSD
          - SNS
          - HONEY
        destinationChain:
          type: string
          enum:
          - ETHEREUM
          - OPTIMISM
          - BINANCE
          - POLYGON
          - ARBITRUM
          - AVALANCHE
          - SOLANA
          - TRON
          - BASE
          - BITCOIN
        destinationCurrency:
          type: string
          enum:
          - USDC
          - USDCE
          - USDBC
          - USDT
          - EURC
          - DAI
          - BUSD
          - BTC
          - ETH
          - BNB
          - MATIC
          - POL
          - AVAX
          - SOL
          - TRX
          - KAP
          - ARB
          - CBBTC
          - PYUSD
          - SNS
          - HONEY
        destinationAddress:
          type: string
        address:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - DEACTIVATED
        label:
          type: string
      required:
      - merchantId
      - livemode
      - chain
      - destinationChain
      - destinationCurrency
      - destinationAddress
      - address
      - status
      definitions: {}
    GetLiquidationAddressResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        createdAt:
          type: number
        updatedAt:
          type: number
        merchantId:
          type: string
        livemode:
          type: boolean
        chain:
          type: string
          enum:
          - ETHEREUM
          - OPTIMISM
          - BINANCE
          - POLYGON
          - ARBITRUM
          - AVALANCHE
          - SOLANA
          - TRON
          - BASE
          - BITCOIN
          - EVM
        currency:
          type: string
          enum:
          - USDC
          - USDCE
          - USDBC
          - USDT
          - EURC
          - DAI
          - BUSD
          - BTC
          - ETH
          - BNB
          - MATIC
          - POL
          - AVAX
          - SOL
          - TRX
          - KAP
          - ARB
          - CBBTC
          - PYUSD
          - SNS
          - HONEY
        destinationChain:
          type: string
          enum:
          - ETHEREUM
          - OPTIMISM
          - BINANCE
          - POLYGON
          - ARBITRUM
          - AVALANCHE
          - SOLANA
          - TRON
          - BASE
          - BITCOIN
        destinationCurrency:
          type: string
          enum:
          - USDC
          - USDCE
          - USDBC
          - USDT
          - EURC
          - DAI
          - BUSD
          - BTC
          - ETH
          - BNB
          - MATIC
          - POL
          - AVAX
          - SOL
          - TRX
          - KAP
          - ARB
          - CBBTC
          - PYUSD
          - SNS
          - HONEY
        destinationAddress:
          type: string
        address:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - DEACTIVATED
        label:
          type: string
      required:
      - merchantId
      - livemode
      - chain
      - destinationChain
      - destinationCurrency
      - destinationAddress
      - address
      - status
      definitions: {}
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: API key as username, empty password
x-provenance:
  method: searched
  source: https://docs.breeze.com/reference
  harvested: '2026-10-28'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.breeze.com/reference/cancelofframprequest.md
  - https://docs.breeze.com/reference/cancelpayoutpage.md
  - https://docs.breeze.com/reference/cancelsubscription.md
  - https://docs.breeze.com/reference/createcustomer.md
  - https://docs.breeze.com/reference/creategatewaypayment.md
  - https://docs.breeze.com/reference/createheadlesspayout.md
  - https://docs.breeze.com/reference/createliquidationaddress.md
  - https://docs.breeze.com/reference/createofframprequest.md
  - https://docs.breeze.com/reference/createpaymentpage.md
  - https://docs.breeze.com/reference/createpayoutpage.md
  - https://docs.breeze.com/reference/createproduct.md
  - https://docs.breeze.com/reference/createproductprice.md
  - https://docs.breeze.com/reference/createsubscription.md
  - https://docs.breeze.com/reference/deletegatewaycustomerpaymentmethod.md
  - https://docs.breeze.com/reference/downloadstatement.md
  - https://docs.breeze.com/reference/expirepaymentpage.md
  - https://docs.breeze.com/reference/getallpaymentattempts.md
  - https://docs.breeze.com/reference/getcustomerbyid.md
  - https://docs.breeze.com/reference/getcustomerbyquery.md
  - https://docs.breeze.com/reference/getfraudreport.md
  - https://docs.breeze.com/reference/getgatewaypayment.md
  - https://docs.breeze.com/reference/getheadlesskycbycustomerreferenceid.md
  - https://docs.breeze.com/reference/getheadlesskycbyid.md
  - https://docs.breeze.com/reference/getinvoice.md
  - https://docs.breeze.com/reference/getliquidationaddress.md
  - https://docs.breeze.com/reference/getliquidationaddresstransaction.md
  - https://docs.breeze.com/reference/getmerchanttaxrate.md
  - https://docs.breeze.com/reference/getofframprequest.md
  - https://docs.breeze.com/reference/getpaymentpage.md
  - https://docs.breeze.com/reference/getpayoutpage.md
  - https://docs.breeze.com/reference/getpayoutpagehistory.md
  - https://docs.breeze.com/reference/getproduct.md
  - https://docs.breeze.com/reference/getrefund.md
  - https://docs.breeze.com/reference/getriskstatus.md
  - https://docs.breeze.com/reference/getsubscription.md
  - https://docs.breeze.com/reference/getsubscriptionbyclientreferenceid.md
  - https://docs.breeze.com/reference/initiateheadlesskyctier3.md
  - https://docs.breeze.com/reference/initiaterefund.md
  - https://docs.breeze.com/reference/listdisputes.md
  - https://docs.breeze.com/reference/listfraudreports.md
  - https://docs.breeze.com/reference/listgatewaycustomerpaymentmethods.md
  - https://docs.breeze.com/reference/listliquidationaddresses.md
  - https://docs.breeze.com/reference/listliquidationaddresstransactions.md
  - https://docs.breeze.com/reference/listpaymentpages.md
  - https://docs.breeze.com/reference/listproducts.md
  - https://docs.breeze.com/reference/liststatements.md
  - https://docs.breeze.com/reference/listsubscriptions.md
  - https://docs.breeze.com/reference/offboardcustomer.md
  - https://docs.breeze.com/reference/releaseofframprequest.md
  - https://docs.breeze.com/reference/releasepayoutpage.md
  - https://docs.breeze.com/reference/resumegatewaypaymentauthentication.md
  - https://docs.breeze.com/reference/sandboxconfirmpayoutpage.md
  - https://docs.breeze.com/reference/simulatesandboxdispute.md
  - https://docs.breeze.com/reference/submitheadlesskycproofofaddresswithupload.md
  - https://docs.breeze.com/reference/submitheadlesskycproofofaddresswithurl.md
  - https://docs.breeze.com/reference/submitheadlesskycwithimageupload.md
  - https://docs.breeze.com/reference/submitheadlesskycwithimageurl.md
  - https://docs.breeze.com/reference/updatecustomer.md
  merge:
    pages: 58
    deduped: 458
    conflicts_kept_first: 0