Breeze.cash

Breeze.cash Offramp API

The Offramp API from Breeze.cash — 4 operation(s) for offramp.

Documentation GitHub OpenAPI

Operations 4

POST /v1/offramp Create an offramp request #

GET /v1/offramp/{id} Get an offramp request by ID #

POST /v1/offramp/{id}/cancel Cancel an offramp request #

POST /v1/offramp/{id}/release Release an offramp request #

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-offramp-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Breeze Offramp 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: Offramp
paths:
  /v1/offramp:
    post:
      operationId: createOfframpRequest
      tags:
      - Offramp
      summary: Create an offramp request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The created offramp
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/CreateOfframpRequestResponse'
                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 new offramp request. Deprecated in favor of Payout Pages.
      deprecated: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOfframpRequestRequest'
  /v1/offramp/{id}:
    get:
      operationId: getOfframpRequest
      tags:
      - Offramp
      summary: Get an offramp request by ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The offramp request details
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/GetOfframpRequestResponse'
                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'
      deprecated: true
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Offramp request ID
  /v1/offramp/{id}/cancel:
    post:
      operationId: cancelOfframpRequest
      tags:
      - Offramp
      summary: Cancel an offramp request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/CancelOfframpRequestResponse'
                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'
      deprecated: true
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: The offramp ID
  /v1/offramp/{id}/release:
    post:
      operationId: releaseOfframpRequest
      tags:
      - Offramp
      summary: Release an offramp request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/ReleaseOfframpRequestResponse'
                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'
      deprecated: true
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Offramp request ID
components:
  schemas:
    CreateOfframpRequestRequest:
      description: Offramp request details
      type: object
      properties:
        network:
          type: string
        token:
          type: string
        amount:
          type: number
          minimum: 100
          maximum: 10000000
          exclusiveMinimum: 0
        email:
          type: string
          format: email
        customer:
          type: object
          properties:
            country:
              const: US
          required:
          - country
          additionalProperties: false
        successReturnUrl:
          type: string
        failReturnUrl:
          type: string
        settings:
          type: object
          properties:
            payByMerchant:
              default: true
              const: true
            feePayByMerchant:
              default: true
              const: true
            releaseMethod:
              type: string
              default: automatic
              enum:
              - automatic
              - manual
          additionalProperties: false
        clientReferenceId:
          type:
          - array
          - boolean
          - number
          - object
          - string
          - 'null'
      required:
      - network
      - token
      - amount
      - email
      - customer
      additionalProperties: false
      deprecated: true
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - FAILED
        errorCode:
          type: string
        errorMessage:
          type: string
      required:
      - status
      - errorCode
      - errorMessage
    CancelOfframpRequestResponse:
      type: object
      deprecated: true
      properties:
        id:
          type: string
          description: The canceled offramp request ID
        status:
          type: string
          enum:
          - CANCELED
    ReleaseOfframpRequestResponse:
      type: object
      deprecated: true
      properties:
        id:
          type: string
          description: The released offramp request ID
        status:
          type: string
          enum:
          - PENDING_DEPOSIT_CRYPTO_MERCHANT
    CreateOfframpRequestResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        network:
          type: string
          enum:
          - ETHEREUM
          - OPTIMISM
          - BINANCE
          - POLYGON
          - ARBITRUM
          - AVALANCHE
          - SOLANA
          - TRON
          - BASE
          - BITCOIN
        token:
          type: string
        amount:
          type: number
        createdAt:
          type: number
        updatedAt:
          type: number
        email:
          type: string
        payByMerchant:
          type: boolean
        feePayByMerchant:
          type: boolean
        clientReferenceId:
          type: string
        successReturnUrl:
          type: string
        failReturnUrl:
          type: string
        status:
          type: string
          enum:
          - CREATED
          - SUCCEEDED
          - CANCELED
          - EXPIRED
          - PENDING_USER_ONBOARDING
          - USER_ACCOUNT_ISSUE
          - PENDING_USER_WITHDRAWAL
          - REQUIRES_RELEASE
          - PENDING_DEPOSIT_CRYPTO_USER
          - PENDING_DEPOSIT_CRYPTO_MERCHANT
          - IN_PROGRESS
          - PENDING_MANUAL_INVESTIGATION
          - REFUNDED
          - REJECTED
        livemode:
          type: boolean
        customerCountry:
          type: string
        customerRegion:
          type: string
        releaseMethod:
          type: string
          enum:
          - automatic
          - manual
        refundedAt:
          type: number
        receiverBankAccountId:
          type: string
        rejectionReason:
          anyOf:
          - type: string
            enum:
            - UNDERAGE
            - UNSUPPORTED_STATE
            - USER_NAME_MISMATCH
            - RISKY
          - type: string
            enum:
            - UNSUPPORTED_STATE
            - UNDERAGE
            - GENERIC_REJECTION
      required:
      - id
      - url
      - network
      - token
      - amount
      - createdAt
      - email
      - payByMerchant
      - feePayByMerchant
      - clientReferenceId
      - status
      - livemode
      - customerCountry
      - releaseMethod
      definitions: {}
      deprecated: true
    GetOfframpRequestResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        network:
          type: string
          enum:
          - ETHEREUM
          - OPTIMISM
          - BINANCE
          - POLYGON
          - ARBITRUM
          - AVALANCHE
          - SOLANA
          - TRON
          - BASE
          - BITCOIN
        token:
          type: string
        amount:
          type: number
        createdAt:
          type: number
        updatedAt:
          type: number
        email:
          type: string
        payByMerchant:
          type: boolean
        feePayByMerchant:
          type: boolean
        clientReferenceId:
          type: string
        successReturnUrl:
          type: string
        failReturnUrl:
          type: string
        status:
          type: string
          enum:
          - CREATED
          - SUCCEEDED
          - CANCELED
          - EXPIRED
          - PENDING_USER_ONBOARDING
          - USER_ACCOUNT_ISSUE
          - PENDING_USER_WITHDRAWAL
          - REQUIRES_RELEASE
          - PENDING_DEPOSIT_CRYPTO_USER
          - PENDING_DEPOSIT_CRYPTO_MERCHANT
          - IN_PROGRESS
          - PENDING_MANUAL_INVESTIGATION
          - REFUNDED
          - REJECTED
        livemode:
          type: boolean
        customerCountry:
          type: string
        customerRegion:
          type: string
        releaseMethod:
          type: string
          enum:
          - automatic
          - manual
        refundedAt:
          type: number
        receiverBankAccountId:
          type: string
        rejectionReason:
          anyOf:
          - type: string
            enum:
            - UNDERAGE
            - UNSUPPORTED_STATE
            - USER_NAME_MISMATCH
            - RISKY
          - type: string
            enum:
            - UNSUPPORTED_STATE
            - UNDERAGE
            - GENERIC_REJECTION
      required:
      - id
      - url
      - network
      - token
      - amount
      - createdAt
      - email
      - payByMerchant
      - feePayByMerchant
      - clientReferenceId
      - status
      - livemode
      - customerCountry
      - releaseMethod
      definitions: {}
      deprecated: true
  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