Breeze.cash Fraud Reports API

openapi: 3.2.0
info:
  title: Breeze Fraud Reports 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: Fraud Reports
paths:
  /v1/fraud_reports:
    get:
      operationId: listFraudReports
      tags:
      - Fraud Reports
      summary: List fraud reports
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: List of fraud reports
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/ListFraudReportsResponse'
                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: pagination
        in: query
        required: false
        schema:
          type: object
          properties:
            offset:
              type: number
              default: 0
              minimum: 0
            limit:
              type: number
              default: 20
              minimum: 1
          additionalProperties: false
      - name: filters
        in: query
        required: false
        schema:
          type: object
          properties:
            clientReferenceId:
              type: string
            email:
              type: string
              format: email
            checkoutPaymentId:
              type: string
            fraudIssueDateRange:
              type: object
              properties:
                start:
                  type: string
                end:
                  type: string
              required:
              - start
              - end
              additionalProperties: false
          additionalProperties: false
  /v1/fraud_reports/{fraudReportId}:
    get:
      operationId: getFraudReport
      tags:
      - Fraud Reports
      summary: Get a fraud report by ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: The fraud report
                properties:
                  status:
                    type: string
                    enum:
                    - SUCCEEDED
                  data:
                    $ref: '#/components/schemas/GetFraudReportResponse'
                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: fraudReportId
        in: path
        required: true
        schema:
          type: string
        description: Fraud report ID
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - FAILED
        errorCode:
          type: string
        errorMessage:
          type: string
      required:
      - status
      - errorCode
      - errorMessage
    GetFraudReportResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        checkoutFraudReport:
          type: object
          properties:
            checkoutPaymentId:
              type: string
            createdAt:
              description: Unix timestamp in milliseconds when Breeze first received the fraud report.
              type: number
            clientReferenceId:
              type: string
            fraudAmountUSD:
              description: Use unitAmount and currency instead.
              type: string
              deprecated: true
            currency:
              description: Uppercase ISO 4217 currency code for the reported fraud amount.
              type: string
            unitAmount:
              description: Fraud amount in minor units of currency (for example, 1250 with currency USD represents USD 12.50).
              type: integer
            fraudReason:
              type: string
            fraudIssueDate:
              type: string
            transactionDate:
              type: string
            issuingBank:
              type: string
            cardholderName:
              type: string
            customerEmail:
              type: string
            cardSchemeType:
              type: string
            cardNumber:
              type: string
          required:
          - checkoutPaymentId
      required:
      - checkoutFraudReport
      definitions: {}
    ListFraudReportsResponse:
      $schema: http://json-schema.org/draft-07/schema#
      type: object
      properties:
        checkoutFraudReports:
          type: array
          items:
            type: object
            properties:
              checkoutPaymentId:
                type: string
              createdAt:
                description: Unix timestamp in milliseconds when Breeze first received the fraud report.
                type: number
              clientReferenceId:
                type: string
              fraudAmountUSD:
                description: Use unitAmount and currency instead.
                type: string
                deprecated: true
              currency:
                description: Uppercase ISO 4217 currency code for the reported fraud amount.
                type: string
              unitAmount:
                description: Fraud amount in minor units of currency (for example, 1250 with currency USD represents USD 12.50).
                type: integer
              fraudReason:
                type: string
              fraudIssueDate:
                type: string
              transactionDate:
                type: string
              issuingBank:
                type: string
              cardholderName:
                type: string
              customerEmail:
                type: string
              cardSchemeType:
                type: string
              cardNumber:
                type: string
            required:
            - checkoutPaymentId
        count:
          type: number
        hasMore:
          type: boolean
      required:
      - checkoutFraudReports
      - count
      - hasMore
      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