Breeze.cash Statements API

openapi: 3.2.0
info:
  title: Breeze Statements 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: Statements
paths:
  /v1/reports/statements:
    get:
      operationId: listStatements
      tags:
      - Statements
      summary: List statements
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: List of statements
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/ListStatementsResponse'
                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: reportType
        in: query
        required: false
        schema:
          type: string
          default: statement
          enum:
          - statement
          - balanceReport
          - paymentPageReport
      - name: type
        in: query
        required: true
        schema:
          type: string
          enum:
          - weekly
          - monthly
          - daily
      - name: accountType
        in: query
        required: true
        schema:
          type: string
          enum:
          - payIn
          - payOut
          - cryptoPayIn
          - icppPayIn
      - name: limit
        in: query
        required: false
        schema:
          type: number
          default: 20
          minimum: 1
          maximum: 100
      - name: offset
        in: query
        required: false
        schema:
          type: number
          default: 0
          minimum: 0
      - name: dateRange
        in: query
        required: false
        schema:
          type: object
          properties:
            start:
              type: number
            end:
              type: number
          required:
          - start
          - end
          additionalProperties: false
  /v1/reports/statements/{id}/download:
    get:
      operationId: downloadStatement
      tags:
      - Statements
      summary: Download a statement
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The download URL
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/DownloadStatementResponse'
                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 signed URL to download the statement file.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Statement ID
components:
  schemas:
    DownloadStatementResponse:
      type: object
      properties:
        url:
          type: string
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - FAILED
        errorCode:
          type: string
        errorMessage:
          type: string
      required:
      - status
      - errorCode
      - errorMessage
    ListStatementsResponse:
      type: object
      properties:
        count:
          type: number
        results:
          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
              status:
                type: string
                enum:
                - pending
                - failed
                - finished
                - skipped
              type:
                type: string
                enum:
                - weekly
                - monthly
                - daily
              accountType:
                type: string
                enum:
                - payIn
                - payOut
                - cryptoPayIn
                - icppPayIn
              minEffectiveAt:
                type: number
              maxEffectiveAt:
                type: number
              amount:
                type: string
              currency:
                type: string
                enum:
                - USD
                - AUD
                - CAD
                - CHF
                - DKK
                - EUR
                - GBP
                - HKD
                - JPY
                - NOK
                - NZD
                - PLN
                - SEK
                - SGD
                - TWD
                - KRW
                - SOL
                - USDC
                - USDT
                - HONEY
                - EURC
              reportFileName:
                type: string
            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