Silverflow Retrieve Reports API

openapi: 3.2.0
info:
  title: Silverflow Retrieve Reports API
  version: 1.417.0
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
  description: 'Operations tagged Retrieve Reports across 2 of this provider''s published API definitions: silverflow-openapi.yml, silverflow-openapi.yml. Each path carries the servers of the definition it was published in.'
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'
    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
  /reports/{reportKey}:
    get:
      operationId: getReport
      summary: Get Report
      description: "Returns a report.\n\nRequires the `reports:Get` permission\n\nFor the **SchemeFeeDetails** and **ReconciliationDetails** reports, their respective permissions are also accepted as alternatives to `reports:Get`.\n  - `reports:GetSchemeFeeDetails`\n  - `reports:GetReconciliationDetails`\n"
      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'
    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
  /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.\n\nTo optimize the file download, the contents are `gzip` encoded. The Response contents need to be unzipped.\n\nNot every report is in `application/json` format, thus there aren't response schema's available for every report type.\n\nThe 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.\n\nRequires one of the following permissions depending on the report:\n  - `reports:Download`\n  - `reports:DownloadSchemeFeeDetails`\n  - `reports:DownloadReconciliationDetails`\n  - `reports:DownloadQuarterlySchemeReport`\n  - `reports:DownloadNetworkFundsTransfers`\n  - `reports:DownloadCharges`\n  - `reports:DownloadFraudNotifications`\n  - `reports:DownloadDisputeHistoryEvents`\n"
      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'
    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
components:
  schemas:
    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.

        '
    chargesReportParameters:
      type: object
      description: The query parameters used for a report.
      required:
      - createdFrom
      - createdTo
      additionalProperties: false
      properties:
        createdFrom:
          type: string
          format: date-time
          description: Include only items that have a created date greater than or equal to the specified date
        createdTo:
          type: string
          format: date-time
          description: Include only items that have a created date less than or equal to the specified date
    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.
    schemas-NonTieredBillingAmountTier:
      title: Non-Tiered Billing Amount Tier
      type: object
      allOf:
      - $ref: '#/components/schemas/schemas-BaseBillingAmountTier'
    components-schemas-version:
      type: integer
      description: The version of this object
      format: int64
      readOnly: true
    reportName:
      type: string
      oneOf:
      - $ref: '#/components/schemas/SchemeFeeDetailsReportName'
      - $ref: '#/components/schemas/ReconciliationDetailsReportName'
      - $ref: '#/components/schemas/FraudNotificationsReportName'
      - $ref: '#/components/schemas/NetworkFundsTransfersReportName'
      - $ref: '#/components/schemas/DisputeHistoryEventsReportName'
      - $ref: '#/components/schemas/ChargesReportName'
      - $ref: '#/components/schemas/VisaQuarterlySchemeReportName'
      - $ref: '#/components/schemas/MastercardQuarterlySchemeReportName'
      - $ref: '#/components/schemas/MerchantPayoutReportName'
      - $ref: '#/components/schemas/InterchangeFeeDowngradeAdvicesReportName'
      - $ref: '#/components/schemas/TransactionFeesReportName'
    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'
    openapi_components-schemas-merchantKey:
      type: string
      pattern: ^mct-[a-zA-Z0-9]+$
      minLength: 24
      maxLength: 120
      description: The unique ID of the _Merchant_ for which this fee has been calculated.
    Fee:
      title: Fee
      description: 'A scheme fee estimate.

        '
      type: object
      required:
      - tiering
      oneOf:
      - $ref: '#/components/schemas/schemas-TieredFee'
      - $ref: '#/components/schemas/schemas-NonTieredFee'
    reconciliationDetailsReportByCreatedTimeParameters:
      type: object
      required:
      - createdFrom
      - createdTo
      description: The query parameters used for a report.
      additionalProperties: false
      properties:
        createdFrom:
          type: string
          format: date-time
          description: Include only items that have a created date greater than or equal to the specified date.
        createdTo:
          type: string
          format: date-time
          description: Include only items that have a created date less than or equal to the specified date.
    schemeFeeDetailsReportMimeType:
      type: string
      description: The mime-type in which the scheme fee details report is available.
      enum:
      - application/json
      - application/x-ndjson
      - text/csv
    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'
    above:
      type: integer
      minimum: 0
      description: 'This field indicates the value above 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.

        '
    components-schemas-offsetToken:
      type: string
      pattern: ^[a-zA-Z0-9%]+$
      minLength: 1
      maxLength: 2048
      example: LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc
    currency:
      type: string
      description: Specifies the currency in which the report will be generated.
      enum:
      - USD
      - EUR
      - SGD
      - GBP
      - PLN
      - THB
      - MYR
      - SEK
    schemeFeeDetailsReportParameters:
      type: object
      description: The query parameters used for a report.
      required:
      - bookDateFrom
      additionalProperties: false
      properties:
        bookDateFrom:
          $ref: '#/components/schemas/bookDateFrom'
        bookDateTo:
          $ref: '#/components/schemas/bookDateTo'
    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-moreItems:
      type: boolean
      description: Boolean indicating if there are more items to retrieve
    SettlementDetailsReportByNftKeyParameters:
      type: object
      description: The query parameters used for a report.
      additionalProperties: false
      required:
      - networkFundsTransferKey
      properties:
        networkFundsTransferKey:
          $ref: '#/components/schemas/networkFundsTransferKey'
    schemas-numberOfTiers:
      type: integer
      minimum: 2
      description: 'The number of tiers defined for this fee.

        '
    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.

        '
    bookDateTo:
      type: string
      format: date-time
      description: Include all scheme fees that have been created earlier than and including from the date specified.
    NotAuthorizedErrorDetails:
      type: object
      required:
      - type
      - title
      - status
      - detail
      - instance
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/errorType'
          - enum:
            - /silverflow/problems/report/not-authorized
        title:
          allOf:
          - $ref: '#/components/schemas/errorTitle'
          - enum:
            - Not authorized
        status:
          allOf:
          - $ref: '#/components/schemas/errorStatus'
          - enum:
            - 401
        detail:
          $ref: '#/components/schemas/errorDetail'
        instance:
          $ref: '#/components/schemas/errorInstance'
    sourceAmountImpact:
      type: string
      enum:
      - debit
      - credit
      description: "The impact of the source amount. This value has no relation to the the _direction_ of the funds\nof the transaction. By default every amount will have the impact set to `debit`. Only _corrections_ \nwill have a value set to `credit`. Note that corrections are not yet supported.\n"
    AgentKey:
      description: Uniquely identifies an Agent
      type: string
      pattern: ^cgt-[a-zA-Z0-9]+|current$
      readOnly: true
      example: cgt-1UF2NafdfrdPMf2XrS2
    disputeHistoryEventsReportMimeType:
      type: string
      description: The mime-type in which the disputes report is available.
      enum:
      - text/csv
      - application/json
      - application/x-ndjson
    schemas-TieredFeeRate:
      title: Tiered Fee Rate
      description: 'A _tiered_ fee rate defines multiple fee rates or _tiers_. 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:
      - tiers
      properties:
        tiers:
          description: 'A list of tiers. Each _tier_ defines a fee rate `value` and a threshold value (`upToIncluding` or

            `above`) to which it applies.

            '
          type: array
          items:
            $ref: '#/components/schemas/schemas-TieredFeeRateTier'
          minItems: 2
      allOf:
      - $ref: '#/components/schemas/schemas-BaseFeeRate'
    ListReportResponse:
      type: object
      required:
      - items
      - moreItems
      properties:
        items:
          type: array
          description: List of reports
          items:
            $ref: '#/components/schemas/Report'
        moreItems:
          $ref: '#/components/schemas/schemas-moreItems'
        offsetToken:
          $ref: '#/components/schemas/components-schemas-offsetToken'
    schemas-BaseBillingAmount:
      type: object
      required:
      - currency
      properties:
        currency:
          $ref: '#/components/schemas/scheme-fee-details_currency'
    AMMFReportName:
      type: string
      description: The name of the report.
      enum:
      - AmmfReport
    NetworkFundsTransfersReport:
      type: object
      required:
      - reportName
      - parameters
      - mimeType
      description: A network funds transfers report.
      allOf:
      - $ref: '#/components/schemas/PublicReport'
      properties:
        reportName:
          $ref: '#/components/schemas/NetworkFundsTransfersReportName'
        parameters:
          $ref: '#/components/schemas/networkFundsTransfersReportParameters'
        mimeType:
          $ref: '#/components/schemas/networkFundsTransfersReportMimeType'
        distributions:
          type: array
          items:
            $ref: '#/components/schemas/distributionKey'
    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.

        '
    openapi_components-schemas-actionReference:
      type: string
      pattern: ^[a-zA-Z0-9()+,\-.:=@;$_!*\/?|]+$
      minLength: 1
      maxLength: 120
      description: 'The action reference of the action for which this fee has been calculated.

        Only present if a `reference` field was specified on the _Charge action_ API call.

        '
    bookDate:
      type: string
      format: date-time
      description: 'The timestamp of which the scheme fee estimate was booked.

        '
    networkFundsTransferKey:
      description: Uniquely identifies a Networks Funds Transfer
      type: string
      pattern: ^nft-[a-zA-Z0-9]+$
      minLength: 10
      maxLength: 120
      example: nft-1e1dAHhgstYTUhlphPzZ
    MastercardQuarterlySchemeReportName:
      type: string
      enum:
      - MastercardQuarterlySchemeReport
    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.

        '
    fraudNotificationsReportParameters:
      type: object
      description: The query parameters used for a report.
      additionalProperties: false
      properties:
        createdFrom:
          type: string
          format: date-time
          description: Include only items that have a created date greater than or equal to the specified date
        createdTo:
          type: string
          format: date-time
          description: Include only items that have a created date less than or equal to the specified date
    errorTitle:
      type: string
      description: 'A short, human-readable summary of the problem type. It does not change from occurrence to occurrence of the error.

        '
    networkFundsTransfersReportParameters:
      type: object
      required:
      - fundsTransferDate
      description: The query parameters used for a report.
      additionalProperties: false
      properties:
        fundsTransferDate:
          type: string
          format: date
          description: Include only items that have a created date greater than or equal to the specified date
    noTiering:
      type: string
      enum:
      - none
      description: 'The type of tiering. The value `none` indicates that this fee is not tiered.

        '
    SettlementDetailsReportName:
      type: string
      description: The name of the report.
      enum:
      - SettlementDetails
    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'
    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}$
    schemas-TieredFeeRateTier:
      title: Tiered Fee Rate Tier
      type: object
      required:
      - tierNumber
      properties:
        tierNumber:
          $ref: '#/components/schemas/schemas-tierNumber'
        upToIncluding:
          $ref: '#/components/schemas/upToIncluding'
        above:
          $ref: '#/components/schemas/above'
      allOf:
      - $ref: '#/components/schemas/schemas-BaseFeeRateTier'
    schemas-bin:
      type: string
      pattern: ^\d+$
      minLength: 6
      maxLength: 6
      description: The value of the _BIN_ for which this fee has been calculated.
    schemas-NonTieredFee:
      title: Non-tiered Fee
      description: A non-tiered scheme fee estimate.
      type: object
      required:
      - tiering
      properties:
        tiering:
          $ref: '#/components/schemas/noTiering'
        feeRate:
          $ref: '#/components/schemas/schemas-NonTieredFeeRate'
        billingAmount:
          $ref: '#/components/schemas/schemas-NonTieredBillingAmount'
      allOf:
      - $ref: '#/components/schemas/schemas-BaseFee'
    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:
            - Report not found
        status:
          allOf:
          - $ref: '#/components/schemas/errorStatus'
          - enum:
            - 404
        detail:
          $ref: '#/components/schemas/errorDetail'
        instance:
          $ref: '#/components/schemas/errorInstance'
    AMMFReportParameters:
      type: object
      description: The parameters used for the AMMF Report.
      required:
      - date
      - acquirerIdCode
      additionalProperties: false
      properties:
        acquirerIdCode:
          $ref: '#/components/schemas/ammfAcquirerIdCode'
        date:
          type: string
          format: date
          description: 'The end date of the AMMF reporting period. The report covers the one-month period ending on this date.

            We recommend using a date in the past to ensure all data for the period has been written.

            '
        directSubmission:
          $ref: '#/components/schemas/ammfDirectSubmission'
    SettlementDetailsReport:
      type: object
      required:
      - reportName
      - parameters
      - mimeType
      description: A SettlementDetails report.
      allOf:
      - $ref: '#/components/schemas/PublicReport'
      properties:
        reportName:
          $ref: '#/components/schemas/SettlementDetailsReportName'
        parameters:
          $ref: '#/components/schemas/SettlementDetailsReportParameters'
        mimeType:
          $ref: '#/components/schemas/SettlementDetailsReportMimeType'
    chargesReportMimeType:
      type: string
      description: The mime-type in which the Charges report is available.
      enum:
      - text/csv
    chargeActionKey:
      type: string
      pattern: ^act-[a-zA-Z0-9]+$
      minLength: 24
      maxLength: 120
      description: 'The unique ID of the _Charge Action_ for which this fee has been calculated. Only present if

        `category` is set to `authorization` or `clearing`.

        '
    feeRateImpact:
      type: string
      enum:
      - debit
      - credit
      description: The impact of the fee.
    ammfReportMimeType:
      type: string
      description: The mime-type in which the AMMF Report is available.
      enum:
      - application/vnd.ms-excel
    openapi_components-schemas-ProblemDetail-2:
      type: object
      description: 'The ''problem detail'' object relays detailed information about the error that occurred. It is defined

        by [RFC 7807 - Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807).


        Note that additional properties may be used to relay error specific information. For instance,

        A Bad Request error may hold information about the individual validation errors found in the request.

        '
      properties:
        type:
          type: string
          description: 'An absolute URI that identifies the problem type.

            '
          default: about:blank
          example: https://api.silverflow.co/problem/constraint-violation
        title:
          type: string
          description: 'A short, summary of the problem type. Written in english and readable

            for engineers (usually not suited for non technical stakeholders and

      

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