Silverflow

Silverflow Report Scheduling API

The Report Scheduling API from Silverflow — 2 operation(s) for report scheduling.

Documentation GitHub OpenAPI

Operations 5

POST /reportSchedules Create a Report Schedule #

GET /reportSchedules List Report Schedules #

GET /reportSchedules/{reportScheduleKey} Get Report Schedule #

DELETE /reportSchedules/{reportScheduleKey} Archive a Report Schedule #

PATCH /reportSchedules/{reportScheduleKey} Update a Report Schedule #

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/silverflow-report-scheduling-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 email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Silverflow Report Scheduling API
  version: 1.417.0
  contact:
    name: API Support
    email: support@silverflow.com
  license:
    name: Commercial
  description: 'Operations tagged Report Scheduling 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: Report Scheduling
paths:
  /reportSchedules:
    post:
      operationId: createReportSchedule
      summary: Create a Report Schedule
      description: 'Creates a new report schedule for generating various types of reports.


        It requires the `reportSchedules:Create` permission in the API key.


        The date range for the report is based on the `trigger` configuration and uses the standard UTC format for all times and timestamps.

        However, to ensure completeness, the report schedule may execute with a slight delay.

        This delay allows the system to capture any last-minute records and ensure accurate and comprehensive data.


        Once the report schedule is executed, a new report will be created, and can be retrieved by calling the [List Reports](#operation/listReport) or [Get Report](#operation/getReport) endpoint.


        To be notified of the creation of these reports, you can subscribe to the reports events using the `eventSource` `https://silverflow.com/reports` on [`POST /v1/eventSubscriptions`](#operation/createEventSubscription).


        When a scheduled report is completed, if it has one of more related distribution objects, it will trigger the distribution to the specified targets.

        '
      tags:
      - Report Scheduling
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReportScheduleRequest'
            examples:
              Scheme Fee Details - Hourly Interval:
                $ref: '#/components/examples/HourlySchemeFeeDetails'
              Scheme Fee Details - Daily Interval:
                $ref: '#/components/examples/DailySchemeFeeDetails'
              Scheme Fee Details - Daily with distributions:
                $ref: '#/components/examples/DailySchemeFeeDetailsWithDistributions'
              Merchant Payout:
                $ref: '#/components/examples/MerchantPayoutRequest'
              Settlement Details - Hourly Interval:
                $ref: '#/components/examples/HourlySettlementDetails'
              Settlement Details - Daily Interval:
                $ref: '#/components/examples/DailySettlementDetails'
              AMMF - Monthly Interval:
                $ref: '#/components/examples/AmmfRequest'
      responses:
        '201':
          description: The newly created report schedule object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportScheduleResponse'
              examples:
                Scheme Fee Details - Hourly Interval:
                  $ref: '#/components/examples/Hourly'
                Scheme Fee Details - Daily Interval:
                  $ref: '#/components/examples/Daily'
                Scheme Fee Details - Daily with distributions:
                  $ref: '#/components/examples/DailyWithDistributions'
                Merchant Payout:
                  $ref: '#/components/examples/MerchantPayoutResponse'
                Settlement Details - Hourly Interval:
                  $ref: '#/components/examples/settlement-details_Hourly'
                Settlement Details - Daily Interval:
                  $ref: '#/components/examples/settlement-details_Daily'
                AMMF - Monthly Interval:
                  $ref: '#/components/examples/AmmfResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InputValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedErrorDetails'
        '403':
          $ref: '#/components/responses/openapi_components-responses-ForbiddenError-3'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/EntityAlreadyExistsErrorDetails'
                - $ref: '#/components/schemas/schemas-ReferencedEntityNotFoundErrorDetails'
                - $ref: '#/components/schemas/ReferencedEntityArchivedErrorDetails'
              examples:
                EntityAlreadyExistsErrorDetails:
                  $ref: '#/components/examples/EntityAlreadyExistsErrorExample'
                ReferencedEntityNotFoundErrorDetails:
                  $ref: '#/components/examples/openapi_components-examples-ReferencedEntityNotFoundErrorExample'
                ReferencedEntityArchivedErrorDetails:
                  $ref: '#/components/examples/ReferencedEntityArchivedErrorExample'
        '429':
          $ref: '#/components/responses/openapi_components-responses-TooManyRequestsError-3'
    get:
      operationId: listReportSchedules
      summary: List Report Schedules
      description: 'Lists all active report schedules.


        It requires the `reportSchedules:List` permission in the API key.

        '
      tags:
      - Report Scheduling
      parameters:
      - $ref: '#/components/parameters/reportName'
      - $ref: '#/components/parameters/parameters-limit'
      - $ref: '#/components/parameters/openapi_components-parameters-offsetToken-3'
      - $ref: '#/components/parameters/components-parameters-sortOrder'
      responses:
        '200':
          description: The report schedules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReportSchedulesResponse'
              example:
                items:
                - reportName: SchemeFeeDetails
                  trigger:
                    type: interval
                    cadence: hourly
                  mimeType: application/json
                  key: rsk-1e1dAHhgstYTUhlphPzZ
                  status: active
                  agentKey: cgt-1e1dAHhgstYTUhlphPzZ
                  created: '2019-08-24T14:15:22Z'
                  lastModified: '2019-08-25T14:15:22Z'
                  version: 2
                  reference: Report Reference
                - reportName: NetworkFundsTransfers
                  trigger:
                    type: interval
                    cadence: daily
                    hour: 15
                  mimeType: text/csv
                  key: rsk-1e1dAHhgstYTUhlphPzZ
                  status: active
                  agentKey: cgt-1e1dAHhgstYTUhlphPzZ
                  created: '2019-08-24T14:15:22Z'
                  lastModified: '2019-08-25T14:15:22Z'
                  version: 2
                  reference: Report Reference
                moreItems: true
                offsetToken: eyJMaXN0SW5kZXhLZXkiOiJjZ3QtMTIzNDU2IiwiTGlzdEluZGV4U29ydEtleSI6IjIwMjMtMTEtMTdUMTQ6NDA6MjcuOTcwWiIsIlR5cGVLZXkiOiJSZXBvcnQiLCJPYmplY3RLZXkiOiJyZXAtMTIzNDU2In0
        '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'
        '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
  /reportSchedules/{reportScheduleKey}:
    get:
      operationId: getReportSchedule
      summary: Get Report Schedule
      description: "Retrieves a specific report schedule identified by its `reportScheduleKey`.\n\nRequirements:\n  - The API key must include the `reportSchedules:Get` permission.\n"
      tags:
      - Report Scheduling
      parameters:
      - in: path
        name: reportScheduleKey
        required: true
        schema:
          $ref: '#/components/schemas/reportScheduleKey'
      responses:
        '200':
          description: Successfully retrieved the report schedule.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/SchemeFeeDetailsReportSchedule'
                - $ref: '#/components/schemas/NetworkFundsTransferReportSchedule'
                - $ref: '#/components/schemas/MerchantPayoutReportSchedule'
                - $ref: '#/components/schemas/ReconciliationDetailsReportSchedule'
                - $ref: '#/components/schemas/SettlementDetailsReportSchedule'
                - $ref: '#/components/schemas/AmmfReportSchedule'
              example:
                reportName: SchemeFeeDetails
                trigger:
                  type: interval
                  cadence: hourly
                mimeType: application/json
                key: rsk-1e1dAHhgstYTUhlphPzZ
                status: active
                agentKey: cgt-1e1dAHhgstYTUhlphPzZ
                created: '2019-08-24T14:15:22Z'
                lastModified: '2019-08-25T14:15:22Z'
                version: 2
                reference: Report Reference
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InputValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedErrorDetails'
        '403':
          $ref: '#/components/responses/openapi_components-responses-ForbiddenError-3'
        '404':
          description: Report schedule not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportScheduleNotFoundErrorDetails'
              example:
                type: /silverflow/problems/report/report-schedule-not-found
                title: Report schedule not found
                status: 404
                detail: The report schedule rsk-1e1dAHhgstYTUhlphPzZ is not found
                instance: /silverflow/b4cc37a0-ab24-46b4-aa8c-cc2d6eddf1b6
        '429':
          $ref: '#/components/responses/openapi_components-responses-TooManyRequestsError-3'
    delete:
      operationId: archiveReportSchedule
      summary: Archive a Report Schedule
      description: 'Archives a report schedule, meaning it will no longer be generating reports.


        It requires the `reportSchedules:Archive` permission in the API key.

        '
      tags:
      - Report Scheduling
      parameters:
      - in: path
        name: reportScheduleKey
        required: true
        schema:
          $ref: '#/components/schemas/reportScheduleKey'
      responses:
        '204':
          description: Successfully archived report schedule
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InputValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedErrorDetails'
        '403':
          $ref: '#/components/responses/openapi_components-responses-ForbiddenError-3'
        '404':
          description: Report schedule not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportScheduleNotFoundErrorDetails'
              example:
                type: /silverflow/problems/report/report-schedule-not-found
                title: Report schedule not found
                status: 404
                detail: The report schedule rsk-1e1dAHhgstYTUhlphPzZ is not found
                instance: /silverflow/b4cc37a0-ab24-46b4-aa8c-cc2d6eddf1b6
        '429':
          $ref: '#/components/responses/openapi_components-responses-TooManyRequestsError-3'
    patch:
      operationId: updateReportSchedule
      summary: Update a Report Schedule
      description: 'Updates an existing report schedule configuration.


        It requires the `reportSchedules:Update` permission in the API key.


        Only active report schedules can be updated. If the schedule is already deleted or archived, the request will result in an error.

        '
      tags:
      - Report Scheduling
      parameters:
      - in: path
        name: reportScheduleKey
        required: true
        schema:
          $ref: '#/components/schemas/reportScheduleKey'
      requestBody:
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/UpdateReportScheduleRequest'
            examples:
              UpdateReportSchedule:
                $ref: '#/components/examples/UpdateReportSchedule'
      responses:
        '200':
          description: The report schedule updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportScheduleResponse'
              example:
                reportName: SchemeFeeDetails
                key: rsk-1e1dAHhgstYTUhlphPzZ
                status: active
                agentKey: cgt-1UF2NafdfrdPMf2XrS2
                created: '2019-08-24T14:15:22Z'
                lastModified: '2019-08-24T14:15:22Z'
                version: 0
                reference: string
                distributions:
                - dst-1e1dAHhgstYTUhlphPzZ
                mimeType: application/json
                trigger:
                  type: interval
                  cadence: hourly
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/InputValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedErrorDetails'
        '403':
          $ref: '#/components/responses/openapi_components-responses-ForbiddenError-3'
        '404':
          description: Report schedule not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportScheduleNotFoundErrorDetails'
              example:
                type: /silverflow/problems/report/report-schedule-not-found
                title: Report schedule not found
                status: 404
                detail: The report schedule rsk-1e1dAHhgstYTUhlphPzZ is not found
                instance: /silverflow/b4cc37a0-ab24-46b4-aa8c-cc2d6eddf1b6
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/EntityAlreadyExistsErrorDetails'
                - $ref: '#/components/schemas/schemas-ReferencedEntityNotFoundErrorDetails'
                - $ref: '#/components/schemas/ReferencedEntityArchivedErrorDetails'
              examples:
                EntityAlreadyExistsErrorDetails:
                  $ref: '#/components/examples/EntityAlreadyExistsErrorExample'
                ReferencedEntityNotFoundErrorDetails:
                  $ref: '#/components/examples/openapi_components-examples-ReferencedEntityNotFoundErrorExample'
                ReferencedEntityArchivedErrorDetails:
                  $ref: '#/components/examples/ReferencedEntityArchivedErrorExample'
        '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:
  parameters:
    components-parameters-sortOrder:
      in: query
      name: sortOrder
      required: false
      description: 'The sort order in which reports should be sorted. Based on the entity creation time.


        `asc` for ascending order, `desc` for descending order.

        '
      schema:
        type: string
        default: asc
        enum:
        - asc
        - desc
      example: asc
    openapi_components-parameters-offsetToken-3:
      in: query
      name: offsetToken
      required: false
      schema:
        $ref: '#/components/schemas/components-schemas-offsetToken'
      description: Token representing the offset for paginated results. Use the token from the last response to retrieve the next set of items.
    parameters-limit:
      in: query
      name: limit
      required: false
      description: The maximum number of reports to retrieve in a single request.
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        default: 10
      example: 1
    reportName:
      name: reportName
      description: The report name to filter on
      in: query
      required: false
      schema:
        oneOf:
        - $ref: '#/components/schemas/SchemeFeeDetailsReportName'
  examples:
    openapi_components-examples-ReferencedEntityNotFoundErrorExample:
      summary: A referenced entity was not found
      value:
        type: /silverflow/problems/report/referenced-entity-not-found
        title: Referenced Entity Not Found
        status: 409
        detail: The referenced distribution key 'dst-1eOdAHhgstYTUhlphPFf' was not found.
        instance: /silverflow/b0451a9d-f66d-4ef7-9f5d-d48064a2bb3e
    MerchantPayoutRequest:
      value:
        reportName: MerchantPayout
        reference: Report Reference
        trigger:
          type: interval
          cadence: daily
          hour: 5
        mimeType: text/csv
        parameters:
          type: Standardized
    DailySettlementDetails:
      value:
        reportName: SettlementDetails
        reference: Report Reference
        trigger:
          type: interval
          cadence: daily
          hour: 5
        mimeType: text/csv
    UpdateReportSchedule:
      value:
        reference: Distributed Report Reference
        trigger:
          type: interval
          cadence: hourly
        mimeType: application/json
        distributions:
        - dst-1e1dAHhgstYTUhlphPzZ
    AmmfResponse:
      value:
        key: rsk-9f9dAHhgstYTUhlphKsm
        reportName: AmmfReport
        trigger:
          type: interval
          cadence: monthly
          hour: 5
          day: 28
        parameters:
          acquirerIdCode: '123456'
          directSubmission: false
        mimeType: application/vnd.ms-excel
        status: active
        agentKey: cgt-1UF2NafdfrdPMf2XrS2
        created: '2026-06-01T08:00:00Z'
        lastModified: '2026-06-01T10:00:00Z'
        version: 1
        reference: AMMF Report Reference
    MerchantPayoutResponse:
      value:
        reportName: SchemeFeeDetails
        trigger:
          type: interval
          cadence: daily
          hour: 12
        mimeType: text/csv
        key: rsk-9f9dAHhgstYTUhlphKsm
        status: active
        agentKey: cgt-1UF2NafdfrdPMf2XrS2
        created: '2024-10-28T08:00:00Z'
        lastModified: '2024-10-28T10:00:00Z'
        version: 1
        reference: Merchant Payout Report
        parameters:
          type: Standardized
    Hourly:
      value:
        reportName: SchemeFeeDetails
        trigger:
          cadence: hourly
          type: interval
        mimeType: application/json
        key: rsk-9f9dAHhgstYTUhlphKsm
        status: active
        agentKey: cgt-1UF2NafdfrdPMf2XrS2
        created: '2024-10-28T08:00:00Z'
        lastModified: '2024-10-28T09:00:00Z'
        version: 1
        reference: Report Reference
    ReferencedEntityArchivedErrorExample:
      summary: A referenced entity is archived
      value:
        type: /silverflow/problems/report/referenced-entity-archived
        title: Referenced Entity Archived
        status: 409
        detail: The referenced distribution with key 'dst-1eOdAHhgstYTUhlphPFf' is archived.
        instance: /silverflow/b0451a9d-f66d-4ef7-9f5d-d48064a2bb3e
    DailySchemeFeeDetailsWithDistributions:
      value:
        reportName: SchemeFeeDetails
        reference: Distributed Report Reference
        trigger:
          type: interval
          cadence: daily
          hour: 12
        mimeType: text/csv
        distributions:
        - dst-1e1dAHhgstYTUhlphPzZ
        - dst-1JRadf2ffdfrdPMf2XrS2
    DailyWithDistributions:
      value:
        reportName: SchemeFeeDetails
        trigger:
          type: interval
          cadence: daily
          hour: 12
        mimeType: text/csv
        key: rsk-9f9dAHhgstYTUhlphKsm
        status: active
        agentKey: cgt-1UF2NafdfrdPMf2XrS2
        created: '2024-10-28T08:00:00Z'
        lastModified: '2024-10-28T10:00:00Z'
        version: 1
        reference: Distributed Report Reference
        distributions:
        - dst-1e1dAHhgstYTUhlphPzZ
        - dst-1JRadf2ffdfrdPMf2XrS2
    settlement-details_Hourly:
      value:
        reportName: SettlementDetails
        trigger:
          cadence: hourly
          type: interval
        mimeType: text/csv
        key: rsk-9f9dAHhgstYTUhlphKsm
        status: active
        agentKey: cgt-1UF2NafdfrdPMf2XrS2
        created: '2024-10-28T08:00:00Z'
        lastModified: '2024-10-28T09:00:00Z'
        version: 1
        reference: Report Reference
    HourlySettlementDetails:
      value:
        reportName: SettlementDetails
        reference: Report Reference
        trigger:
          type: interval
          cadence: hourly
        mimeType: text/csv
    EntityAlreadyExistsErrorExample:
      summary: A scheduled report with the passed values already exist
      value:
        type: /silverflow/problems/report/entity-already-exists
        title: Entity Already Exists
        status: 409
        detail: A report schedule with the passed values already exists.
        instance: /silverflow/b0451a9d-f66d-4ef7-9f5d-d48064a2bb3e
    DailySchemeFeeDetails:
      value:
        reportName: SchemeFeeDetails
        reference: Report Reference
        trigger:
          type: interval
          cadence: daily
          hour: 5
        mimeType: application/json
    settlement-details_Daily:
      value:
        reportName: SettlementDetails
        trigger:
          type: interval
          cadence: daily
          hour: 14
        mimeType: text/csv
        key: rsk-9f9dAHhgstYTUhlphKsm
        status: active
        agentKey: cgt-1UF2NafdfrdPMf2XrS2
        created: '2024-10-28T08:00:00Z'
        lastModified: '2024-10-28T10:00:00Z'
        version: 1
        reference: Report Reference
    AmmfRequest:
      value:
        reportName: AmmfReport
        reference: AMMF Report Reference
        trigger:
          type: interval
          cadence: monthly
          hour: 5
          day: 28
        parameters:
          acquirerIdCode: '123456'
          directSubmission: false
        mimeType: application/vnd.ms-excel
    HourlySchemeFeeDetails:
      value:
        reportName: SchemeFeeDetails
        reference: Report Reference
        trigger:
          type: interval
          cadence: hourly
        mimeType: application/json
    Daily:
      value:
        reportName: SchemeFeeDetails
        trigger:
          type: interval
          cadence: daily
          hour: 14
        mimeType: application/json
        key: rsk-9f9dAHhgstYTUhlphKsm
        status: active
        agentKey: cgt-1UF2NafdfrdPMf2XrS2
        created: '2024-10-28T08:00:00Z'
        lastModified: '2024-10-28T10:00:00Z'
        version: 1
        reference: Report Reference
  schemas:
    components-schemas-version:
      type: integer
      description: The version of this object
      format: int64
      readOnly: true
    AMMFReportScheduleParameters:
      type: object
      description: The parameters used for creating a merchant payout report schedule.
      required:
      - acquirerIdCode
      additionalProperties: false
      properties:
        acquirerIdCode:
          $ref: '#/components/schemas/ammfAcquirerIdCode'
        directSubmission:
          $ref: '#/components/schemas/ammfDirectSubmission'
    schemeFeeDetailsReportMimeType:
      type: string
      description: The mime-type in which the scheme fee details report is available.
      enum:
      - application/json
      - application/x-ndjson
      - text/csv
    BaseCreateReportScheduleRequest:
      type: object
      description: The base report scheduling fields
      properties:
        reference:
          $ref: '#/components/schemas/components-schemas-reference'
        distributions:
          $ref: '#/components/schemas/distributions'
    components-schemas-offsetToken:
      type: string
      pattern: ^[a-zA-Z0-9%]+$
      minLength: 1
      maxLength: 2048
      example: LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc
    disputeHistoryEventsScheduleTrigger:
      type: object
      description: The trigger conditions for the Dispute History Events report schedule.
      oneOf:
      - $ref: '#/components/schemas/hourlyCadence'
      - $ref: '#/components/schemas/dailyCadence'
    ReconciliationDetailsReportSchedule:
      allOf:
      - type: object
        required:
        - reportName
        properties:
          reportName:
            $ref: '#/components/schemas/ReconciliationDetailsReportName'
      - $ref: '#/components/schemas/BaseReportSchedule'
      - type: object
        required:
        - trigger
        - mimeType
        properties:
          mimeType:
            $ref: '#/components/schemas/reconciliationDetailsReportMimeType'
          trigger:
            $ref: '#/components/schemas/reconciliationDetailsScheduleTrigger'
    CreateReportScheduleRequest:
      type: object
      discriminator:
        propertyName: reportName
        mapping:
          SchemeFeeDetails: '#/components/schemas/CreateSchemeFeeDetailsScheduleRequest'
          NetworkFundsTransfers: '#/components/schemas/CreateNetworkFundsTransfersScheduleRequest'
          MerchantPayout: '#/components/schemas/CreateMerchantPayoutScheduleRequest'
          ReconciliationDetails: '#/components/schemas/CreateReconciliationDetailScheduleRequest'
          Charges: '#/components/schemas/CreateChargesScheduleRequest'
          DisputeHistoryEvents: '#/components/schemas/CreateDisputeHistoryEventsScheduleRequest'
          FraudNotifications: '#/components/schemas/CreateFraudNotificationsScheduleRequest'
          SettlementDetails: '#/components/schemas/CreateSettlementDetailsScheduleRequest'
          AmmfReport: '#/components/schemas/CreateAmmfReportScheduleRequest'
      oneOf:
      - $ref: '#/components/schemas/CreateSchemeFeeDetailsScheduleRequest'
      - $ref: '#/components/schemas/CreateNetworkFundsTransfersScheduleRequest'
      - $ref: '#/components/schemas/CreateMerchantPayoutScheduleRequest'
      - $ref: '#/components/schemas/CreateReconciliationDetailScheduleRequest'
      - $ref: '#/components/schemas/CreateChargesScheduleRequest'
      - $ref: '#/components/schemas/CreateDisputeHistoryEventsScheduleRequest'
      - $ref: '#/components/schemas/CreateFraudNotificationsScheduleRequest'
      - $ref: '#/components/schemas/CreateSettlementDetailsScheduleRequest'
      - $ref: '#/components/schemas/CreateAmmfReportScheduleRequest'
    CreateMerchantPayoutScheduleRequest:
      allOf:
      - type: object
        description: A schedule for Merchant Payout reports
        required:
        - reportName
        - trigger
        - mimeType
        - parameters
        properties:
          reportName:
            $ref: '#/components/schemas/MerchantPayoutReportName'
          mimeType:
            $ref: '#/components/schemas/MerchantPayoutReportMimeType'
          trigger:
            $ref: '#/components/schemas/MerchantPayoutScheduleTrigger'
          parameters:
            $ref: '#/components/schemas/MerchantPayoutReportScheduleParameters'
      - $ref: '#/components/schemas/BaseCreateReportScheduleRequest'
    schemas-moreItems:
      type: boolean
      description: Boolean indicating if there are more items to retrieve
    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'
    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
    UpdateFraudNotificationsScheduleRequest:
      type: object
      description: A schedule for Fraud Notifications reports
      additionalProperties: false
      properties:
        mimeType:
          $ref: '#/components/schemas/fraudNotificationsReportMimeType'
        trigger:
          $ref: '#/components/schemas/fraudNotificationsScheduleTrigger'
        reference:
          $ref: '#/components/schemas/components-schemas-reference'
        distributions:
          $ref: '#/components/schemas/distributions'
    AmmfReportScheduleTrigger:
      type: object
      description: The trigger conditions for the AMMF Report schedule.
      oneOf:
      - $ref: '#/components/schemas/monthlyCadence'
    AMMFReportName:
      type: string
      description: The name of the report.
      enum:
      - AmmfReport
    ChargesReportSchedule:
      allOf:
      - type: object
        required:
        - reportName
        properties:
          reportName:
            $ref: '#/components/schemas/ChargesReportName'
      - $ref: '#/components/schemas/BaseReportSchedule'
      - type: object
        required:
        - trigger
        - mimeType
        properties:
          mimeType:


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