Silverflow Retrieve Reports API

openapi: 3.2.0
info:
  description: '**This OpenAPI specification cannot be used for code generation.** Please reach out to your TAM regarding code generation using the API Spec.'
  version: 1.417.0
  title: Silverflow Retrieve Reports API
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
servers:
- url: https://eu-west-1.api.silverflow.com/v1
  description: Production URL for Europe - Equivalent to https://api.silverflow.co/v1
- url: https://us-east-2.api.silverflow.com/v1
  description: Production URL for North America
- url: https://eu-west-1.api-sbx.silverflow.com/v1
  description: Sandbox URL - Equivalent to https://api-sbx.silverflow.co/v1
security:
- ApiKey: []
- BearerToken: []
tags:
- name: Retrieve Reports
paths:
  /reports:
    get:
      operationId: listReport
      summary: List Reports
      description: 'Returns a list of reports.


        Requires the `reports:List` permission.'
      tags:
      - Retrieve Reports
      parameters:
      - $ref: '#/components/parameters/createdFrom'
      - $ref: '#/components/parameters/createdTo'
      - $ref: '#/components/parameters/parameters-limit'
      - $ref: '#/components/parameters/openapi_components-parameters-offsetToken-3'
      - $ref: '#/components/parameters/components-parameters-sortOrder'
      responses:
        '200':
          description: List of reports
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReportResponse'
              example:
                items:
                - reportName: SchemeFeeDetails
                  parameters:
                    bookDateFrom: '2019-08-24T14:15:22Z'
                    bookDateTo: '2019-08-24T14:15:22Z'
                  mimeType: application/json
                  key: rep-1e1dAHhgstYTUhlphPzZ
                  agentKey: cgt-1e1dAHhgstYTUhlphPzZ
                  reference: Report Reference
                  status: completed
                  result:
                    size: 1337
                    lastToken: ZfDH6YfTwPU2TweAN6a5Rk6cLZ1Xxyms
                  created: '2019-08-24T14:15:22Z'
                  lastModified: '2019-08-25T14:15:22Z'
                  version: 2
                moreItems: true
                offsetToken: eyJMaXN0SW5kZXhLZXkiOiJjZ3QtMTIzNDU2IiwiTGlzdEluZGV4U29ydEtleSI6IjIwMjMtMTEtMTdUMTQ6NDA6MjcuOTcwWiIsIlR5cGVLZXkiOiJSZXBvcnQiLCJPYmplY3RLZXkiOiJyZXAtMTIzNDU2In0
        '204':
          description: No report found
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InputValidationError'
                - $ref: '#/components/schemas/schemas-InvalidOffsetTokenError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedErrorDetails'
              example:
                type: /silverflow/problems/report/not-authorized
                title: Not authorized
                status: 401
                detail: The agent is not authorized to perform this action
                instance: /silverflow/8e445b2e-d745-4b38-a38d-781fc998e442
        '403':
          $ref: '#/components/responses/openapi_components-responses-ForbiddenError-3'
        '429':
          $ref: '#/components/responses/openapi_components-responses-TooManyRequestsError-3'
  /reports/{reportKey}:
    get:
      operationId: getReport
      summary: Get Report
      description: 'Returns a report.


        Requires the `reports:Get` permission


        For the **SchemeFeeDetails** and **ReconciliationDetails** reports, their respective permissions are also accepted as alternatives to `reports:Get`.

        - `reports:GetSchemeFeeDetails`

        - `reports:GetReconciliationDetails`'
      tags:
      - Retrieve Reports
      parameters:
      - in: path
        name: reportKey
        required: true
        schema:
          $ref: '#/components/schemas/reportKey'
      responses:
        '200':
          description: A report object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
              examples:
                schemeFeeDetails:
                  $ref: '#/components/examples/SchemeFeeDetailsReport'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InputValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedErrorDetails'
              example:
                type: /silverflow/problems/report/not-authorized
                title: Not authorized
                status: 401
                detail: The agent is not authorized to perform this action
                instance: /silverflow/8e445b2e-d745-4b38-a38d-781fc998e442
        '403':
          $ref: '#/components/responses/openapi_components-responses-ForbiddenError-3'
        '404':
          description: Report not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportNotFoundErrorDetails'
              example:
                type: /silverflow/problems/report/report-not-found
                title: Report not found
                status: 404
                detail: The report rep-1e1dAHhgstYTUhlphPzZ is not found
                instance: /silverflow/b4cc37a0-ab24-46b4-aa8c-cc2d6eddf1b6
        '429':
          $ref: '#/components/responses/openapi_components-responses-TooManyRequestsError-3'
  /reports/{reportKey}/file:
    get:
      operationId: getReportFile
      summary: Get Report File
      description: 'Returns the Report data as a downloadable file. This will return a `307` (redirect) status code, redirecting the request to the location of the file.


        To optimize the file download, the contents are `gzip` encoded. The Response contents need to be unzipped.


        Not every report is in `application/json` format, thus there aren''t response schema''s available for every report type.


        The file URL the request is redirected to, will remain **available for 1 hour**. After this time, you need to call this endpoint to generate a new URL. Make sure your HTTP client is configured to follow redirects, so you can correctly obtain the file.


        Requires one of the following permissions depending on the report:

        - `reports:Download`

        - `reports:DownloadSchemeFeeDetails`

        - `reports:DownloadReconciliationDetails`

        - `reports:DownloadQuarterlySchemeReport`

        - `reports:DownloadNetworkFundsTransfers`

        - `reports:DownloadCharges`

        - `reports:DownloadFraudNotifications`

        - `reports:DownloadDisputeHistoryEvents`'
      tags:
      - Retrieve Reports
      parameters:
      - in: path
        name: reportKey
        required: true
        schema:
          $ref: '#/components/schemas/reportKey'
      responses:
        '204':
          description: The report is not available to download yet
        '307':
          description: Report file
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/SchemeFeeDetailsReportFile'
              examples:
                schemeFeeDetailsReport:
                  $ref: '#/components/examples/JSON'
            application/x-ndjson:
              schema:
                oneOf:
                - type: string
                  title: SchemeFeeDetails
              examples:
                schemeFeeDetailsReport:
                  $ref: '#/components/examples/NDJSON'
            text/csv:
              schema:
                type: string
              examples:
                schemeFeeDetailsReport:
                  $ref: '#/components/examples/CSV'
            application/vnd.ms-excel:
              schema:
                oneOf:
                - type: string
                  title: VisaQuarterlySchemeReport
                - type: string
                  title: MastercardQuarterlySchemeReport
          headers:
            Content-Disposition:
              schema:
                type: string
                enum:
                - attachment
            Content-Encoding:
              schema:
                type: string
                enum:
                - gzip
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InputValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedErrorDetails'
              example:
                type: /silverflow/problems/report/not-authorized
                title: Not authorized
                status: 401
                detail: The agent is not authorized to perform this action
                instance: /silverflow/8e445b2e-d745-4b38-a38d-781fc998e442
        '403':
          $ref: '#/components/responses/openapi_components-responses-ForbiddenError-3'
        '404':
          description: Report not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportNotFoundErrorDetails'
              example:
                type: /silverflow/problems/report/report-not-found
                title: Report not found
                status: 404
                detail: The report rep-1e1dAHhgstYTUhlphPzZ is not found
                instance: /silverflow/b4cc37a0-ab24-46b4-aa8c-cc2d6eddf1b6
        '415':
          description: Unsupported mimeType
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedMimeTypeErrorDetails'
              example:
                type: /silverflow/problems/report/unsupported-mime-type
                title: Unsupported mimeType
                status: 415
                detail: Unsupported mimeType 'text/csv'
                instance: /silverflow/b4cc37a0-ab24-46b4-aa8c-cc2d6eddf1b6
        '429':
          $ref: '#/components/responses/openapi_components-responses-TooManyRequestsError-3'
components:
  schemas:
    feeDescription:
      type: string
      pattern: ^[a-zA-Z0-9-\/ \.—&()]+$
      minLength: 1
      maxLength: 120
      description: 'The Mastercard _"Event description"_ or the Visa _"Description"_, as they appear on the corresponding

        invoices.

        '
    merchantAcceptorKey:
      type: string
      pattern: ^mac-[a-zA-Z0-9]+$
      minLength: 24
      maxLength: 120
      description: The unique ID of the _Merchant Acceptor_ for which this fee has been calculated.
    VisaQuarterlySchemeReportParameters:
      type: object
      description: The parameters used for the VisaQuarterlySchemeReport.
      required:
      - network
      - bid
      - year
      - quarter
      - currency
      additionalProperties: false
      properties:
        network:
          type: string
          description: The card network.
          enum:
          - visa
        bid:
          type: string
          description: The assigned Business Identifier of the acquirer.
          pattern: ^[a-zA-Z0-9]+$
          minLength: 1
          maxLength: 120
        quarter:
          $ref: '#/components/schemas/quarter'
        year:
          $ref: '#/components/schemas/year'
        currency:
          $ref: '#/components/schemas/currency'
    UnsupportedMimeTypeErrorDetails:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/errorType'
          - enum:
            - /silverflow/problems/report/unsupported-mime-type
        title:
          allOf:
          - $ref: '#/components/schemas/errorTitle'
          - enum:
            - Unsupported mimeType
        status:
          allOf:
          - $ref: '#/components/schemas/errorStatus'
          - enum:
            - 415
        detail:
          $ref: '#/components/schemas/errorDetail'
        instance:
          $ref: '#/components/schemas/errorInstance'
    billingAmountImpact:
      type: string
      enum:
      - debit
      - credit
      description: The impact of the billing amount.
    feeDate:
      type: string
      format: date-time
      description: 'The fee date. This is the date (and time) of the event for which this fee was _incurred_.

        Formatted as [ISO 8601 Date](https://en.wikipedia.org/wiki/ISO_8601) and time in UTC.

        '
    schemas-InvalidOffsetTokenError:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/errorType'
          - enum:
            - /silverflow/problems/report/invalid-offset-token
        title:
          allOf:
          - $ref: '#/components/schemas/errorTitle'
          - enum:
            - Invalid Offset Token
        status:
          allOf:
          - $ref: '#/components/schemas/errorStatus'
          - enum:
            - 400
        detail:
          $ref: '#/components/schemas/errorDetail'
        instance:
          $ref: '#/components/schemas/errorInstance'
    billingFrequency:
      type: string
      enum:
      - daily
      - weekly
      - monthly
      - quarterly
      description: 'The _frequency_ or _interval_ at which this fee is witheld from settlement (or

        invoiced separately). This frequency also defines the _aggregation period_ for _tiered fees_.

        '
    sourceAmountValue:
      type: string
      pattern: ^\d+(\.\d+)?$
      minLength: 1
      description: 'The source amount value, encoded as string. If this value holds a fraction,

        it will use a `.` "dot" as _decimal separator_. Note that it may hold up to 11 decimals.

        Use a _platform specific number parser_ to convert this string into a numeric value

        without loosing precision.

        '
    schemas-TieredFee:
      title: Tiered Fee
      description: A tiered scheme fee estimate. A _tiered_ fee defines multiple fee rates. When `tiering` is set to `count` the applicable tier is selected based on the total number of fees in a given period. When `tiering` is set to `volume` the applicable tier is selected based on the total source amount (denominated in the `feeRate` currency) of the fees in a given period. Tier applicability is determined by the `upToIncluding` and `above` values. For a fee with `tiering` set to `count`, these properties hold the thresholds for the total number of fees in the defined period. Conversely, for a fee with `tiering` set to `volume` these properties define the threshold for the total source amount (denominated in the `feeRate` currency). The aggregation period is defined by the `billingFrequency` field.
      type: object
      required:
      - tiering
      - numberOfTiers
      properties:
        tiering:
          $ref: '#/components/schemas/volumeCountTiering'
        numberOfTiers:
          $ref: '#/components/schemas/schemas-numberOfTiers'
        feeRate:
          $ref: '#/components/schemas/schemas-TieredFeeRate'
        billingAmount:
          $ref: '#/components/schemas/schemas-TieredBillingAmount'
      allOf:
      - $ref: '#/components/schemas/schemas-BaseFee'
    SettlementDetailsReportParameters:
      oneOf:
      - $ref: '#/components/schemas/SettlementDetailsReportByCreatedTimeParameters'
      - $ref: '#/components/schemas/SettlementDetailsReportByNftKeyParameters'
    openapi_components-schemas-cardNetwork-2:
      enum:
      - visa
      - mastercard
      description: The _card network_ imposing the fee.
    conversionRateDate:
      type: string
      format: date
      description: "The date of the conversion rate. Conversion rates are published (daily) by the _card schemes_. \nThe method of publication introduces certain delays. Hence, this date may lie before the `feeDate`.\n"
    schemas-BaseFee:
      title: Base Fee
      type: object
      required:
      - key
      - agentKey
      - cardNetwork
      - binKey
      - bin
      - acquirerIdCode
      - merchantAcceptorKey
      - merchantKey
      - mid
      - billingFrequency
      - feeId
      - feeDescription
      - feeDate
      - sourceAmount
      - bookDate
      properties:
        key:
          $ref: '#/components/schemas/key'
        agentKey:
          $ref: '#/components/schemas/openapi_components-schemas-agentKey'
        cardNetwork:
          $ref: '#/components/schemas/openapi_components-schemas-cardNetwork-2'
        binKey:
          $ref: '#/components/schemas/openapi_components-schemas-binKey'
        bin:
          $ref: '#/components/schemas/schemas-bin'
        acquirerIdCode:
          $ref: '#/components/schemas/openapi_components-schemas-acquirerIdCode'
        merchantAcceptorKey:
          $ref: '#/components/schemas/merchantAcceptorKey'
        merchantKey:
          $ref: '#/components/schemas/openapi_components-schemas-merchantKey'
        mid:
          $ref: '#/components/schemas/openapi_components-schemas-mid'
        threeDsKey:
          $ref: '#/components/schemas/threeDsKey'
        chargeKey:
          $ref: '#/components/schemas/openapi_components-schemas-chargeKey'
        chargeActionKey:
          $ref: '#/components/schemas/chargeActionKey'
        clearingArn:
          $ref: '#/components/schemas/clearingArn'
        transactionReference:
          $ref: '#/components/schemas/openapi_components-schemas-transactionReference'
        actionReference:
          $ref: '#/components/schemas/openapi_components-schemas-actionReference'
        billingFrequency:
          $ref: '#/components/schemas/billingFrequency'
        tierId:
          $ref: '#/components/schemas/schemas-tierId'
        feeId:
          $ref: '#/components/schemas/feeId'
        feeDescription:
          $ref: '#/components/schemas/feeDescription'
        feeDate:
          $ref: '#/components/schemas/feeDate'
        sourceAmount:
          $ref: '#/components/schemas/SourceAmount'
        conversionRates:
          $ref: '#/components/schemas/ConversionRates'
        convertedSourceAmount:
          $ref: '#/components/schemas/ConvertedSourceAmount'
        bookDate:
          $ref: '#/components/schemas/bookDate'
    ammfAcquirerIdCode:
      type: string
      description: the Acquirer Institution ID. For Visa, this is the BIC. It should be a 6-digit numeric value.
      pattern: ^\d{6}$
    Report:
      type: object
      oneOf:
      - $ref: '#/components/schemas/SchemeFeeDetailsReport'
      - $ref: '#/components/schemas/ReconciliationDetailsReport'
      - $ref: '#/components/schemas/FraudNotificationsReport'
      - $ref: '#/components/schemas/NetworkFundsTransfersReport'
      - $ref: '#/components/schemas/DisputeHistoryEventsReport'
      - $ref: '#/components/schemas/ChargesReport'
      - $ref: '#/components/schemas/VisaQuarterlySchemeReport'
      - $ref: '#/components/schemas/MastercardQuarterlySchemeReport'
      - $ref: '#/components/schemas/AmmfReport'
      - $ref: '#/components/schemas/SettlementDetailsReport'
    MastercardQuarterlySchemeReportParameters:
      type: object
      description: The parameters used for the MastercardQuarterlySchemeReport.
      required:
      - network
      - acquirerIdCode
      - year
      - quarter
      - currency
      additionalProperties: false
      properties:
        network:
          type: string
          description: The card network.
          enum:
          - mastercard
        acquirerIdCode:
          type: string
          description: The Acquirer Institution ID code. For Mastercard, this is the Acquirer ICA (Interbank Card Association) code, which is a unique identifier for the acquirer. It should be a 6-digit numeric value.
          pattern: ^\d{6}$
        quarter:
          $ref: '#/components/schemas/quarter'
        year:
          $ref: '#/components/schemas/year'
        currency:
          $ref: '#/components/schemas/currency'
    openapi_components-schemas-created-2:
      type: string
      description: The date and time this object was created
      format: date-time
      readOnly: true
    components-schemas-version:
      type: integer
      description: The version of this object
      format: int64
      readOnly: true
    errorStatus:
      type: integer
      format: int32
      description: 'The HTTP status code generated by the origin server for this occurrence

        of the problem.

        '
    schemas-tierId:
      type: string
      pattern: ^[A-Z0-9-]+$
      minLength: 1
      maxLength: 120
      description: 'The (optional) Mastercard _"Tier ID"_ for this fee, as it appears on the Mastercard invoice.

        Note that the presence of this field does not indicate if this fee has multiple _tiers_.

        See the `tiering` field.

        '
    upToIncluding:
      type: integer
      minimum: 0
      description: 'This field indicates the value up to (including) which this _tier_ applies.

        If `tiering` is set to `volume`, this value indicates the total `sourceAmount`

        (in `feeRate` currency). If `tiering` is set to `count`, this value indicates the

        total number of fees.

        '
    reconciliationDetailsReportParameters:
      oneOf:
      - $ref: '#/components/schemas/reconciliationDetailsReportByCreatedTimeParameters'
      - $ref: '#/components/schemas/reconciliationDetailsReportByNftKeyParameters'
    feeRateType:
      type: string
      enum:
      - fixed
      - basisPoints
      description: 'The type of fee. The value `fixed` indicates that the `value` field holds a _fixed_ fee amount,

        denominated in the specified `currency`. The value `basisPoints` indicates that the `value`

        fields holds the (decimal) number of basis points of the fee, applied to the `sourceAmount`

        or `convertedSourceAmount` in case the `currency` does not match the `sourceAmount` currency.

        '
    fraudNotificationsReportMimeType:
      type: string
      description: The mime-type in which the fraud notifications report is available.
      enum:
      - text/csv
      - application/json
      - application/x-ndjson
    AmmfReport:
      type: object
      required:
      - reportName
      - parameters
      - mimeType
      description: An AMMF report.
      allOf:
      - $ref: '#/components/schemas/PublicReport'
      properties:
        reportName:
          $ref: '#/components/schemas/AMMFReportName'
        parameters:
          $ref: '#/components/schemas/AMMFReportParameters'
        mimeType:
          $ref: '#/components/schemas/ammfReportMimeType'
    errorInstance:
      type: string
      description: 'A reference that identifies the specific occurrence of the error. The instance is unique for every error.

        '
    reportKey:
      description: Uniquely identifies a report object
      type: string
      pattern: ^rep-[a-zA-Z0-9]+$
      minLength: 10
      maxLength: 120
      example: rep-1e1dAHhgstYTUhlphPzZ
    scheme-fee-details_currency:
      type: string
      enum:
      - EUR
      - USD
      - AFN
      - ALL
      - DZD
      - AOA
      - XCD
      - ARS
      - AMD
      - AWG
      - AUD
      - AZN
      - BSD
      - BHD
      - BDT
      - BBD
      - BYN
      - BZD
      - XOF
      - BMD
      - INR
      - BTN
      - BOB
      - BAM
      - BWP
      - NOK
      - BRL
      - BND
      - BGN
      - BIF
      - CVE
      - KHR
      - XAF
      - CAD
      - KYD
      - CLP
      - CNY
      - COP
      - KMF
      - CDF
      - NZD
      - CRC
      - HRK
      - CUP
      - CUC
      - ANG
      - CZK
      - DKK
      - DJF
      - DOP
      - EGP
      - SVC
      - ERN
      - ETB
      - FKP
      - FJD
      - XPF
      - GMD
      - GEL
      - GHS
      - GIP
      - GTQ
      - GBP
      - GNF
      - GYD
      - HTG
      - HNL
      - HKD
      - HUF
      - ISK
      - IDR
      - IRR
      - IQD
      - ILS
      - JMD
      - JPY
      - JOD
      - KZT
      - KES
      - KPW
      - KRW
      - KWD
      - KGS
      - LAK
      - LBP
      - LSL
      - ZAR
      - LRD
      - LYD
      - CHF
      - MOP
      - MKD
      - MGA
      - MWK
      - MYR
      - MVR
      - MRU
      - MUR
      - MXN
      - MDL
      - MNT
      - MAD
      - MZN
      - MMK
      - NAD
      - NPR
      - NIO
      - NGN
      - OMR
      - PKR
      - PAB
      - PGK
      - PYG
      - PEN
      - PHP
      - PLN
      - QAR
      - RON
      - RUB
      - RWF
      - SHP
      - WST
      - STN
      - SAR
      - RSD
      - SCR
      - SLL
      - SGD
      - SBD
      - SOS
      - SSP
      - LKR
      - SDG
      - SRD
      - SZL
      - SEK
      - SYP
      - TWD
      - TJS
      - TZS
      - THB
      - TOP
      - TTD
      - TND
      - TRY
      - TMT
      - UGX
      - UAH
      - AED
      - UYU
      - UYW
      - UZS
      - VUV
      - VES
      - VND
      - YER
      - ZMW
      - ZWL
      description: The currency.
    chargesReportMimeType:
      type: string
      description: The mime-type in which the Charges report is available.
      enum:
      - text/csv
    errorType:
      type: string
      description: 'A relative URI reference, this property can be used to perform automated error handling.

        '
    openapi_components-schemas-acquirerIdCode:
      type: string
      pattern: ^\d+$
      minLength: 6
      maxLength: 6
      description: 'The value of the _Acquirer ID Code_ for which this fee has been calculated. For Mastercard,

        this field corresponds to the _Acquirer ICA_. For Visa, this field corresponds to the _CIB_,

        which usually has the same value as the _BIN_.

        '
    InputValidationError:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      - validationErrors
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/errorType'
          - enum:
            - /silverflow/problems/invalid-input
        title:
          allOf:
          - $ref: '#/components/schemas/errorTitle'
          - enum:
            - Invalid Input
        status:
          allOf:
          - $ref: '#/components/schemas/errorStatus'
          - enum:
            - 400
        detail:
          allOf:
          - $ref: '#/components/schemas/errorDetail'
          - enum:
            - The request does not adhere to the defined API schema.
        instance:
          $ref: '#/components/schemas/errorInstance'
        validationErrors:
          type: array
          items:
            $ref: '#/components/schemas/openapi_components-schemas-ValidationError'
          description: A list of validation errors.
    schemas-ConversionRate:
      title: Conversion Rate
      type: object
      required:
      - date
      - source
      - target
      - rate
      - operation
      properties:
        date:
          $ref: '#/components/schemas/conversionRateDate'
        source:
          $ref: '#/components/schemas/scheme-fee-details_currency'
        target:
          $ref: '#/components/schemas/scheme-fee-details_currency'
        rate:
          $ref: '#/components/schemas/currencyRateValue'
        operation:
          $ref: '#/components/schemas/operation'
    errorDetail:
      type: string
      description: 'A human readable explanation specific to this occurrence of the problem.

        '
    ConversionRates:
      title: Conversion Rates
      description: 'A list of conversion rates, used to convert the `sourceAmount` into the `convertedSourceAmount`.

        This list is only present if currency conversion was applied. Currency conversion is only applied

        if the `feeRate` currency is different from the `sourceAmount` currency. Note that for certain

        currency conversions there is no single rate available. In such a case, multiple conversions are

        applied to convert the source amount into the fee rate currency.

        '
      type: array
      items:
        $ref: '#/components/schemas/schemas-ConversionRate'
      minItems: 1
    schemas-BaseFeeRate:
      title: Base Fee Rate
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/feeRateType'
        currency:
          $ref: '#/components/schemas/scheme-fee-details_currency'
    PublicReport:
      type: object
      required:
      - key
      - agentKey
      - status
      - created
      - version
      description: A report entity.
      properties:
        key:
          $ref: '#/components/schemas/reportKey'
        agentKey:
          $ref: '#/components/schemas/AgentKey'
        reference:
          $ref: '#/components/schemas/components-schemas-reference'
        status:
          $ref: '#/components/schemas/reportStatus'
        result:
          $ref: '#/components/schemas/schemas-Result'
        created:
          $ref: '#/components/schemas/openapi_components-schemas-created-2'
        lastModified:
          $ref: '#/components/schemas/openapi_components-schemas-lastModified'
        version:
          $ref: '#/components/schemas/components-schemas-version'
        distributions:
          type: array
          items:
            $ref: '#/components/schemas/distributionKey'
        reportScheduleKey:
          $ref: '#/components/schemas/reportScheduleKey'
    threeDsKey:
      type: string
      pattern: ^tds-[a-zA-Z0-9]+$
      minLength: 24
      maxLength: 120
      description: 'The unique ID of the _3DS_ for which this fee has been calculated. Only present if

        `category` is set to `authentication`.

        '
    SchemeFeeDetailsReportName:
      type: string
      description: The name of the report.
      enum:
      - SchemeFeeDetails
    schemas-NonTieredFeeRate:
      title: Non Tiered Fee Rate
      description: 'A _(non-tiered)_ fee rate.

        '
      type: object
      required:
      - tiers
      properties:
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/schemas-NonTieredFeeRateTier'
          minItems: 1
          maxItems: 1
      allOf:
      - $ref: '#/components/schemas/schemas-BaseFeeRate'
    openapi_components-schemas-transactionReference:
      type: string
      pattern: ^[a-zA-Z0-9()+,\-.:=@;$_!*\/?|]+$
      minLength: 1
      maxLength: 120
      description: 'The _transaction reference_ of the transaction for which this fee has been calculated.

        Only present if a `transactionReference` field was specified on the _3DS_ or _Charge_ creation

        API call.

        '
    VisaQuarterlySchemeReport:
      type: object
      required:
      - reportName
      - parameters
      - mimeType
      description: A Visa Quarterly Scheme report
      allOf:
      - $ref: '#/components/schemas/PublicReport'
      properties:
        reportName:
          $ref: '#/components/schemas/VisaQuarterlySchemeReportName'
        parameters:
          $ref: '#/components/schemas/VisaQuarterlySchemeReportParameters'
        mimeType:
          $ref: '#/components/schemas/quarterlySchemeReportMimeType'
    SourceAmount:
      title: Amount
      description: The _source_ amount of the transaction event, in either the original (transaction) currency or the settlement currency. This amount is the amount to which the fee applies.
      type: object
      required:
      - impact
      - currency
      - value
      properties:
        impact:
          $ref: '#/components/schemas/sourceAmountImpact'
        currency:
          $ref: '#/components/schemas/scheme-fee-details_currency'
        value:
          $ref: '#/components/schemas/sourceAmountValue'
    ReportNotFoundErrorDetails:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/errorType'
          - enum:
            - /silverflow/problems/report/report-not-found
        title:
          allOf:
          - $ref: '#/components/schemas/errorTitle'
          - enum:
         

# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/silverflow/refs/heads/main/openapi/silverflow-retrieve-reports-api-openapi.yml