---
title: "Create Quarterly Scheme Report"
method: POST
path: "/reports/quarterlySchemeReport"
tags: ["Card Network Reports"]
---

# Create Quarterly Scheme Report

`POST /reports/quarterlySchemeReport`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/reports/quarterlySchemeReport`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/reports/quarterlySchemeReport/post.ts> (a function with typed inputs; its response is checked against the schema)

Schedules the creation of a Quarterly Scheme Report by acquirer and card scheme.

Reports can only be created for quarters that ended within the last 2 years.

Requires the `reports:Create` permission to **create** the report, but for downloading the report you need the `reports:DownloadQuarterlySchemeReport` permission.

Please check our detailed guide on the report content and other considerations [here](https://docs.silverflow.com/guides/card-network-reports).

## Request body

- union
  - VisaQuarterlySchemeReportRequest
    - `parameters` VisaQuarterlySchemeReportParameters, required: The parameters used for the VisaQuarterlySchemeReport.
      - `network` 'visa', required: The card network.
      - `bid` string, required: The assigned Business Identifier of the acquirer.
      - `quarter` 1 | 2 | 3 | 4, required: Specifies the quarter of the year for the report. Valid values are 1 (Q1), 2 (Q2), 3 (Q3), and 4 (Q4).
      - `year` integer, required: The year for which the report is being generated. It should be a four-digit number (e.g., 2023).
      - `currency` 'USD' | 'EUR' | 'SGD' | 'GBP' | 'PLN' | 'THB' | 'MYR' | 'SEK', required: Specifies the currency in which the report will be generated.
    - `reference` string: Unique ID used to identify a quarterly scheme report.
    - `mimeType` 'application/vnd.ms-excel', required: The mime-type in which the Quarterly Scheme Report is available.
    - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed.
  - MastercardQuarterlySchemeReportRequest
    - `parameters` MastercardQuarterlySchemeReportParameters, required: The parameters used for the MastercardQuarterlySchemeReport.
      - `network` 'mastercard', required: The card network.
      - `acquirerIdCode` string, required: 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.
      - `quarter` 1 | 2 | 3 | 4, required: Specifies the quarter of the year for the report. Valid values are 1 (Q1), 2 (Q2), 3 (Q3), and 4 (Q4).
      - `year` integer, required: The year for which the report is being generated. It should be a four-digit number (e.g., 2023).
      - `currency` 'USD' | 'EUR' | 'SGD' | 'GBP' | 'PLN' | 'THB' | 'MYR' | 'SEK', required: Specifies the currency in which the report will be generated.
    - `reference` string: Unique ID used to identify a quarterly scheme report.
    - `mimeType` 'application/vnd.ms-excel', required: The mime-type in which the Quarterly Scheme Report is available.
    - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed.

## Response `201`

The scheduled Quarterly Scheme Report

- union
  - VisaQuarterlySchemeReportResponse
    - `reportName` 'VisaQuarterlySchemeReport', required
    - `parameters` VisaQuarterlySchemeReportParameters, required: The parameters used for the VisaQuarterlySchemeReport.
      - `network` 'visa', required: The card network.
      - `bid` string, required: The assigned Business Identifier of the acquirer.
      - `quarter` 1 | 2 | 3 | 4, required: Specifies the quarter of the year for the report. Valid values are 1 (Q1), 2 (Q2), 3 (Q3), and 4 (Q4).
      - `year` integer, required: The year for which the report is being generated. It should be a four-digit number (e.g., 2023).
      - `currency` 'USD' | 'EUR' | 'SGD' | 'GBP' | 'PLN' | 'THB' | 'MYR' | 'SEK', required: Specifies the currency in which the report will be generated.
    - `mimeType` 'application/vnd.ms-excel', required: The mime-type in which the Quarterly Scheme Report is available.
    - `key` string, required: Uniquely identifies a report object
    - `agentKey` string, required: Uniquely identifies an Agent
    - `reference` string: Unique ID used to identify a quarterly scheme report.
    - `status` 'scheduled', required: The status of the report.
    - `created` string, date-time, required: The date and time this object was created
    - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed.
  - MastercardQuarterlySchemeReportResponse
    - `reportName` 'MastercardQuarterlySchemeReport', required
    - `parameters` MastercardQuarterlySchemeReportParameters, required: The parameters used for the MastercardQuarterlySchemeReport.
      - `network` 'mastercard', required: The card network.
      - `acquirerIdCode` string, required: 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.
      - `quarter` 1 | 2 | 3 | 4, required: Specifies the quarter of the year for the report. Valid values are 1 (Q1), 2 (Q2), 3 (Q3), and 4 (Q4).
      - `year` integer, required: The year for which the report is being generated. It should be a four-digit number (e.g., 2023).
      - `currency` 'USD' | 'EUR' | 'SGD' | 'GBP' | 'PLN' | 'THB' | 'MYR' | 'SEK', required: Specifies the currency in which the report will be generated.
    - `mimeType` 'application/vnd.ms-excel', required: The mime-type in which the Quarterly Scheme Report is available.
    - `key` string, required: Uniquely identifies a report object
    - `agentKey` string, required: Uniquely identifies an Agent
    - `reference` string: Unique ID used to identify a quarterly scheme report.
    - `status` 'scheduled', required: The status of the report.
    - `created` string, date-time, required: The date and time this object was created
    - `distributions` DistributionKey[]: The distribution objects' keys. If passed, the report will be distributed when generation is completed.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: The authenticated client is forbidden to make the request for the resource identified.
- `429`: The number of requests (per minute) has exceeded the configured maximum

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)