Breeze.cash

Breeze.cash Webhooks API

Events Breeze sends to your configured webhook endpoint. Each delivery is an HTTP POST with a `{ type, data, signature }` body. Verify the signature before trusting the payload, and return a 2xx status to acknowledge receipt.

Documentation GitHub OpenAPI

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-webhooks-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 Webhooks 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: Webhooks
  description: Events Breeze sends to your configured webhook endpoint. Each delivery is an HTTP POST with a `{ type, data, signature }` body. Verify the signature before trusting the payload, and return a 2xx status to acknowledge receipt.
paths: {}
webhooks:
  PAYMENT_SUCCEEDED:
    post:
      operationId: webhook_PAYMENT_SUCCEEDED
      tags:
      - Webhooks
      summary: Payment succeeded
      description: Sent when a hosted payment page reaches the PAID state.
      requestBody:
        required: true
        description: Event payload delivered to the merchant's configured webhook URL.
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - PAYMENT_SUCCEEDED
                data:
                  $ref: '#/components/schemas/PaymentPageStatusChangedWebhookData'
                signature:
                  type: string
                  description: Base64-encoded HMAC-SHA256 of the `data` object, signed with your webhook secret. Use it to verify authenticity.
              required:
              - type
              - data
              - signature
      responses:
        '200':
          description: Return any 2xx status to acknowledge receipt. Non-2xx or timeout triggers retries.
  PAYOUT_PAGE_STATUS_UPDATE:
    post:
      operationId: webhook_PAYOUT_PAGE_STATUS_UPDATE
      tags:
      - Webhooks
      summary: Payout page status update
      description: Sent when a payout page's status changes.
      requestBody:
        required: true
        description: Event payload delivered to the merchant's configured webhook URL.
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - PAYOUT_PAGE_STATUS_UPDATE
                data:
                  $ref: '#/components/schemas/PayoutPageStatusChangedWebhookData'
                signature:
                  type: string
                  description: Base64-encoded HMAC-SHA256 of the `data` object, signed with your webhook secret. Use it to verify authenticity.
              required:
              - type
              - data
              - signature
      responses:
        '200':
          description: Return any 2xx status to acknowledge receipt. Non-2xx or timeout triggers retries.
  REFUND_STATUS_UPDATE:
    post:
      operationId: webhook_REFUND_STATUS_UPDATE
      tags:
      - Webhooks
      summary: Refund status update
      description: Sent when a payin refund's status changes.
      requestBody:
        required: true
        description: Event payload delivered to the merchant's configured webhook URL.
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - REFUND_STATUS_UPDATE
                data:
                  $ref: '#/components/schemas/PaymentPageRefundStatusChangedWebhookData'
                signature:
                  type: string
                  description: Base64-encoded HMAC-SHA256 of the `data` object, signed with your webhook secret. Use it to verify authenticity.
              required:
              - type
              - data
              - signature
      responses:
        '200':
          description: Return any 2xx status to acknowledge receipt. Non-2xx or timeout triggers retries.
components:
  schemas:
    PayoutPageStatusChangedWebhookData:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        id:
          type: string
        status:
          type: string
          enum:
          - CREATED
          - PENDING
          - PROCESSING
          - PROCESSED
          - ON_HOLD
          - REFUNDED
          - EXPIRED
          - CANCELLED
          - REJECTED
        amount:
          type: number
        fundingCurrency:
          type: string
          enum:
          - USDC
          - USDCE
          - USDBC
          - USDT
          - EURC
          - DAI
          - BUSD
          - BTC
          - ETH
          - BNB
          - MATIC
          - POL
          - AVAX
          - SOL
          - TRX
          - KAP
          - ARB
          - CBBTC
          - PYUSD
          - SNS
          - HONEY
        clientReferenceId:
          type: string
        releaseMethod:
          type: string
          enum:
          - MANUAL
          - AUTOMATIC
        merchant:
          type: object
          properties:
            id:
              type: string
            livemode:
              type: boolean
          required:
          - id
          - livemode
          additionalProperties: false
        customer:
          type: object
          properties:
            id:
              type: string
            referenceId:
              type: string
            email:
              type: string
          required:
          - email
          additionalProperties: false
        successReturnUrl:
          type: string
        failureReturnUrl:
          type: string
        pendingStatus:
          type: string
          enum:
          - PENDING_USER_CONFIRMATION
          - PENDING_USER_ONBOARDING
          - PENDING_MERCHANT_RELEASE
        payoutMethod:
          type: string
          enum:
          - BANK_ACCOUNT
          - CRYPTO_WALLET
          - CARD
          - BREEZE_CARD
        customerConfirmedAt:
          type: number
        processedAt:
          type: number
        refundedAt:
          type: number
        rejectedAt:
          type: number
        rejectionReason:
          type: string
        cardLast4:
          type: string
          description: Only sent when last-4 reporting is enabled for the merchant.
        bankAccountLast4:
          type: string
          description: Only sent when last-4 reporting is enabled for the merchant.
      required:
      - id
      - status
      - amount
      - fundingCurrency
      - clientReferenceId
      - releaseMethod
      - merchant
      - customer
      additionalProperties: false
      description: '`data` for PAYOUT_PAGE_STATUS_UPDATE.'
      definitions: {}
    PaymentPageStatusChangedWebhookData:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        pageId:
          type: string
        billingEmail:
          type: string
        currency:
          type: string
        amount:
          type: number
          description: Integer, in the currency's minor unit (e.g. 641 = 6.41).
        clientReferenceId:
          type: string
        status:
          type: string
          enum:
          - UNPAID
          - PAID
          - EXPIRED
          - CANCELED
        flexibleAmount:
          type: object
          properties:
            requested:
              type: number
            received:
              type: number
          required:
          - requested
          - received
          additionalProperties: false
          description: Present only for flexible-amount pages.
        payment:
          type: object
          properties:
            currency:
              type: string
            requested:
              type: string
            received:
              type: string
            receivedPercentage:
              type: string
          required:
          - currency
          - requested
          - received
          - receivedPercentage
          additionalProperties: false
          description: Present only for flexible-amount pages.
        customer:
          type: object
          properties:
            id:
              type: string
            referenceId:
              type: string
            email:
              type: string
          required:
          - id
          - referenceId
          additionalProperties: false
        payinDetails:
          type: object
          properties:
            type:
              type: string
              enum:
              - card
              - crypto
              - apple_pay
              - google_pay
            amount:
              type: number
            grossAmount:
              type: number
            currency:
              type: string
            scheme:
              type: string
              description: See `Payment.scheme` — may contain legacy un-normalized values from historical documents.
            bin:
              type: string
            last4:
              type: string
            issuer:
              type: string
            issuerCountry:
              type: string
            cardType:
              type: string
              enum:
              - CREDIT
              - DEBIT
              - PREPAID
              - CHARGE
              - DEFERRED DEBIT
            acquirerReferenceNumber:
              type: string
            firstName:
              type: string
            lastName:
              type: string
            expiryMonth:
              type: number
            expiryYear:
              type: number
            threeDS:
              type: object
              properties:
                requested:
                  type: boolean
                flow:
                  type: string
                  enum:
                  - CHALLENGE
                  - FRICTIONLESS
                eci:
                  type: string
                authentication_status_code:
                  type: string
              required:
              - requested
              additionalProperties: false
            taxAmount:
              type: number
            taxProductCategory:
              type: string
            taxZipcode:
              type: string
            taxCountry:
              type: string
            network:
              type: string
            token:
              type: string
            transactionHash:
              type: string
            fromAddress:
              type: string
          additionalProperties: false
        source:
          type: string
          enum:
          - direct
          - iap
          - subscription
          - card-verification
          - consumer-onramp
      required:
      - pageId
      - currency
      - amount
      - status
      additionalProperties: false
      description: '`data` for PAYMENT_CREATED / PAYMENT_SUCCEEDED / PAYMENT_EXPIRED.'
      definitions: {}
    PaymentPageRefundStatusChangedWebhookData:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        pageId:
          type: string
        refundId:
          type: string
        status:
          type: string
          enum:
          - new
          - processing
          - succeeded
          - failed
        refundAmount:
          type: number
        pageAmount:
          type: number
        currency:
          type: string
        pageCurrency:
          type: string
          description: Currently in testing and will be enabled for all merchants soon. Please contact our integration team to enable this.
        refundCurrency:
          type: string
          description: Currently in testing and will be enabled for all merchants soon. Please contact our integration team to enable this.
        checkoutPaymentId:
          type: string
        reason:
          type: string
        operator:
          type: string
        lastError:
          type: string
        customer:
          type: object
          properties:
            id:
              type: string
            referenceId:
              type: string
            email:
              type: string
          required:
          - id
          - referenceId
          additionalProperties: false
      required:
      - pageId
      - refundId
      - status
      - refundAmount
      - pageAmount
      - currency
      - checkoutPaymentId
      additionalProperties: false
      description: '`data` for REFUND_STATUS_UPDATE.'
      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