Breeze.cash Payout Pages API

The Payout Pages API from Breeze.cash — 5 operation(s) for payout pages.

Operations 6

POST /v1/payout_pages Create a payout page #
GET /v1/payout_pages List payout pages #
GET /v1/payout_pages/{id} Get a payout page by ID #
POST /v1/payout_pages/{id}/cancel Cancel a payout page #
POST /v1/payout_pages/{id}/release Release a payout page #
POST /v1/payout_pages/{id}/sandbox_confirm Sandbox confirm a payout page #

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-payout-pages-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-payout-pages-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Breeze Payout Pages 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: Payout Pages
paths:
  /v1/payout_pages:
    post:
      operationId: createPayoutPage
      tags:
      - Payout Pages
      summary: Create a payout page
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The created payout page
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/CreatePayoutPageResponse'
                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'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePayoutPageRequest'
    get:
      operationId: getPayoutPageHistory
      tags:
      - Payout Pages
      summary: List payout pages
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: A list of payout pages
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/GetPayoutPageHistoryResponse'
                  hasMore:
                    type: boolean
                  nextCursorToken:
                    type: string
                    description: Pass this value as cursorToken in the next request to fetch the next page. Absent when there are no more items.
                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 paginated list of payout pages. Use the nextCursorToken from the response as cursorToken in the next request to page through results. When hasMore is false, you have reached the last page.
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 30
      - name: cursorToken
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - CREATED
            - PENDING
            - PROCESSING
            - PROCESSED
            - ON_HOLD
            - REFUNDED
            - EXPIRED
            - CANCELLED
            - REJECTED
          description: Filter by payout page status. Repeat the parameter to filter by multiple statuses (e.g. status=CREATED&status=PENDING).
        description: Filter by payout page status. Repeat the parameter to filter by multiple statuses (e.g. status=CREATED&status=PENDING).
      - name: email
        in: query
        required: false
        schema:
          type: string
          format: email
      - name: id
        in: query
        required: false
        schema:
          type: string
  /v1/payout_pages/{id}:
    get:
      operationId: getPayoutPage
      tags:
      - Payout Pages
      summary: Get a payout page by ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The payout page
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/GetPayoutPageResponse'
                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: Payout page ID
  /v1/payout_pages/{id}/cancel:
    post:
      operationId: cancelPayoutPage
      tags:
      - Payout Pages
      summary: Cancel a payout page
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/SuccessResponse'
                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: Payout page ID
  /v1/payout_pages/{id}/release:
    post:
      operationId: releasePayoutPage
      tags:
      - Payout Pages
      summary: Release a payout page
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/SuccessResponse'
                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: Releases a payout page for processing.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Payout page ID
  /v1/payout_pages/{id}/sandbox_confirm:
    post:
      operationId: sandboxConfirmPayoutPage
      tags:
      - Payout Pages
      summary: Sandbox confirm a payout page
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The confirmed payout page
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/SandboxConfirmPayoutPageResponse'
                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: Confirms a payout page in the sandbox environment, transitioning it to the specified status.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Payout page ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxConfirmPayoutPageRequest'
components:
  schemas:
    SandboxConfirmPayoutPageResponse:
      type: object
      properties:
        id:
          type: string
          description: Payout page ID
      required:
      - id
    SuccessResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - SUCCEEDED
        data:
          type: object
      required:
      - status
    CreatePayoutPageResponse:
      $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
        payoutDestinationRail:
          type: string
          enum:
          - ach
          - sepa
          - card_usd
          - zengin
          - hkd_fps
          - krw_kftc
        clientReferenceId:
          type: string
        releaseMethod:
          type: string
          enum:
          - MANUAL
          - AUTOMATIC
        merchant:
          type: object
          properties:
            id:
              type: string
            livemode:
              type: boolean
          required:
          - id
          - livemode
        customer:
          type: object
          properties:
            id:
              type: string
            referenceId:
              type: string
            email:
              type: string
          required:
          - email
        successReturnUrl:
          type: string
        failureReturnUrl:
          type: string
        url:
          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
        resultCode:
          type: string
        resultMessage:
          type: string
        cardLast4:
          type: string
          description: Please contact our integration team to enable this.
        bankAccountLast4:
          type: string
          description: Please contact our integration team to enable this.
      required:
      - id
      - status
      - amount
      - fundingCurrency
      - clientReferenceId
      - releaseMethod
      - merchant
      - customer
      - url
      definitions: {}
    CreatePayoutPageRequest:
      description: Payout page details
      type: object
      properties:
        amount:
          type: number
          minimum: 100
          maximum: 10000000
          exclusiveMinimum: 0
        fundingCurrency:
          type: string
          enum:
          - USDC
          - EURC
        clientReferenceId:
          type: string
          minLength: 1
        releaseMethod:
          type: string
          enum:
          - MANUAL
          - AUTOMATIC
        customer:
          type: object
          properties:
            id:
              type: string
            referenceId:
              type: string
            email:
              type: string
              format: email
          required:
          - email
          additionalProperties: false
          oneOf:
          - required:
            - id
            title: By Id
          - required:
            - referenceId
            title: By Reference Id
          - not:
              oneOf:
              - required:
                - id
              - required:
                - referenceId
              - required:
                - id
                - referenceId
            title: Neither
        successReturnUrl:
          type: string
          minLength: 1
        failureReturnUrl:
          type: string
          minLength: 1
      required:
      - amount
      - fundingCurrency
      - clientReferenceId
      - releaseMethod
      - customer
      additionalProperties: false
    SandboxConfirmPayoutPageRequest:
      description: Status to transition the payout page to
      type: object
      properties:
        status:
          type: string
          enum:
          - CREATED
          - PENDING
          - PROCESSING
          - PROCESSED
          - REFUNDED
          - EXPIRED
          - CANCELLED
          - REJECTED
      required:
      - status
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - FAILED
        errorCode:
          type: string
        errorMessage:
          type: string
      required:
      - status
      - errorCode
      - errorMessage
    GetPayoutPageResponse:
      $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
        payoutDestinationRail:
          type: string
          enum:
          - ach
          - sepa
          - card_usd
          - zengin
          - hkd_fps
          - krw_kftc
        clientReferenceId:
          type: string
        releaseMethod:
          type: string
          enum:
          - MANUAL
          - AUTOMATIC
        merchant:
          type: object
          properties:
            id:
              type: string
            livemode:
              type: boolean
          required:
          - id
          - livemode
        customer:
          type: object
          properties:
            id:
              type: string
            referenceId:
              type: string
            email:
              type: string
          required:
          - email
        successReturnUrl:
          type: string
        failureReturnUrl:
          type: string
        url:
          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
        resultCode:
          type: string
        resultMessage:
          type: string
        cardLast4:
          type: string
          description: Please contact our integration team to enable this.
        bankAccountLast4:
          type: string
          description: Please contact our integration team to enable this.
      required:
      - id
      - status
      - amount
      - fundingCurrency
      - clientReferenceId
      - releaseMethod
      - merchant
      - customer
      - url
      definitions: {}
    GetPayoutPageHistoryResponse:
      type: array
      items:
        $schema: http://json-schema.org/draft-07/schema#
        type: object
        properties:
          id:
            type: string
          email:
            type: string
          clientReferenceId:
            type: string
          status:
            type: string
            enum:
            - CREATED
            - PENDING
            - PROCESSING
            - PROCESSED
            - ON_HOLD
            - REFUNDED
            - EXPIRED
            - CANCELLED
            - REJECTED
          pendingStatus:
            type: string
            enum:
            - PENDING_USER_CONFIRMATION
            - PENDING_USER_ONBOARDING
            - PENDING_MERCHANT_RELEASE
          createdAt:
            type: number
          customerConfirmedAt:
            type: number
          sourceAmount:
            type: string
          sourceCurrency:
            type: string
            enum:
            - USDC
            - USDCE
            - USDBC
            - USDT
            - EURC
            - DAI
            - BUSD
            - BTC
            - ETH
            - BNB
            - MATIC
            - POL
            - AVAX
            - SOL
            - TRX
            - KAP
            - ARB
            - CBBTC
            - PYUSD
            - SNS
            - HONEY
          payoutMethodType:
            type: string
            enum:
            - BANK_ACCOUNT
            - CRYPTO_WALLET
            - CARD
            - BREEZE_CARD
          receipt:
            type: object
            properties:
              emailOfframpProcessStartedSent:
                type: boolean
              receiverNetAmount:
                type: number
              fee:
                type: object
                properties:
                  processingFee:
                    type: number
                  cryptoGasFee:
                    type: number
                  newUserFee:
                    type: number
                  totalFee:
                    type: number
                required:
                - totalFee
              feePayer:
                type: string
                enum:
                - MERCHANT
                - CUSTOMER
              destCurrency:
                type: string
                enum:
                - USDC
                - USDCE
                - USDBC
                - USDT
                - EURC
                - DAI
                - BUSD
                - BTC
                - ETH
                - BNB
                - MATIC
                - POL
                - AVAX
                - SOL
                - TRX
                - KAP
                - ARB
                - CBBTC
                - PYUSD
                - SNS
                - HONEY
                - USD
                - AUD
                - CAD
                - CHF
                - DKK
                - EUR
                - GBP
                - HKD
                - JPY
                - NOK
                - NZD
                - PLN
                - SEK
                - SGD
                - TWD
                - KRW
              bankAccount:
                type: object
                properties:
                  bankAccountId:
                    type: string
                  bankName:
                    type: string
                  bankAccountNumberLast4:
                    type: string
                  bankRoutingNumber:
                    type: string
                  achTraceNumber:
                    type: string
                required:
                - bankAccountId
                - bankName
                - bankAccountNumberLast4
              cryptoWallet:
                type: object
                properties:
                  walletAddress:
                    type: string
                  destNetwork:
                    type: string
                    enum:
                    - ETHEREUM
                    - OPTIMISM
                    - BINANCE
                    - POLYGON
                    - ARBITRUM
                    - AVALANCHE
                    - SOLANA
                    - TRON
                    - BASE
                    - BITCOIN
                  destToken:
                    type: string
                    enum:
                    - USDC
                    - USDCE
                    - USDBC
                    - USDT
                    - EURC
                    - DAI
                    - BUSD
                    - BTC
                    - ETH
                    - BNB
                    - MATIC
                    - POL
                    - AVAX
                    - SOL
                    - TRX
                    - KAP
                    - ARB
                    - CBBTC
                    - PYUSD
                    - SNS
                    - HONEY
                  transactionHash:
                    type: string
                required:
                - walletAddress
                - destNetwork
                - destToken
              card:
                type: object
                properties:
                  cardId:
                    type: string
                  cardLast4:
                    type: string
                  cardScheme:
                    type: string
                    enum:
                    - VISA
                    - MASTERCARD
                    - AMERICAN_EXPRESS
                    - DISCOVER
                    - DINERS
                    - CARTES_BANCAIRES
                required:
                - cardId
                - cardLast4
                - cardScheme
              breezeCard:
                type: object
                properties:
                  consumerId:
                    type: string
                  cardLast4:
                    type: string
                  cardNetwork:
                    type: string
                required:
                - consumerId
                - cardLast4
            required:
            - receiverNetAmount
            - fee
            - feePayer
            - destCurrency
          rejectionReason:
            anyOf:
            - type: string
              enum:
              - UNDERAGE
              - UNSUPPORTED_STATE
              - USER_NAME_MISMATCH
              - RISKY
            - type: string
              enum:
              - UNSUPPORTED_STATE
              - UNDERAGE
              - GENERIC_REJECTION
          resultCode:
            type: string
          resultMessage:
            type: string
        required:
        - id
        - email
        - clientReferenceId
        - status
        - createdAt
        - sourceAmount
        - sourceCurrency
        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