# Create Report
source: https://developer.mastercard.com/iccp/documentation/05_api_reference/soap_api/reports/create_reports/index.md

> Initiate the report creation process for authorization or clearing transactions performed using a VCN for a specific date range. This API call returns a report ID to
> use in a get report call to retrieve the generated report.

## Request Headers {#request-headers}

|    Key name     |                     Value                      |                                                                                                                Description for ICCP                                                                                                                 |
|-----------------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Idempotency-Key | Any random UUID set in the HTTP Request Header | 1. The header key Idempotency-Key is optional. 2. If the header key Idempotency-Key is added, then it should be non-null and non-empty. 3. The max length of the key is 80 chars. 4. It is recommended that the key is UUID and generated randomly. |

## Parameters {#parameters}

|       Names       |                                                                                                                                                                                                                                                Description                                                                                                                                                                                                                                                 | Required for ICCP | Required for ICMP |     Type     |
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------|--------------|
| `FromDate`        | * Start date of the report * Date format: YYYY-MM-DD                                                                                                                                                                                                                                                                                                                                                                                                                                                       | Yes               | Yes               | Alphanumeric |
| `ToDate`          | * End date of the report * Date format: YYYY-MM-DD * FromDate and ToDate can be the same day and will provide data from that day * The maximum report duration is 31 days. * A report has a limit of 50,000 transactions that will be returned. It is recommended to manage the date range requested to account for the limitation.                                                                                                                                                                        | Yes               | Yes               | Alphanumeric |
| `FromTime`        | * Time format: HH:mm * TimeZone only supports Winter timings.                                                                                                                                                                                                                                                                                                                                                                                                                                              | No                | No                | Alphanumeric |
| `ToTime`          | * Time format: HH:mm * TimeZone only supports Winter timings.                                                                                                                                                                                                                                                                                                                                                                                                                                              | No                | No                | Alphanumeric |
| `TimeZone`        | Time zone, which does not change the transaction dates contained in the report as these are always represented in UTC. For a list of supported time zones, refer to the API schema documents (XSD files) or the ( [list_of_supported_time_zones.pdf](https://static.developer.mastercard.com/content/iccp/swagger/list_of_supported_time_zones.pdf) (295KB))                                                                                                                                               | Yes               | Yes               | Alphabetic   |
| `TransactionType` | * [Authorization TransactionType values](https://developer.mastercard.com/iccp/documentation/05_api_reference/soap_api/reports/create_reports/index.md#authorization-transactiontype-values) * [Clearings TransactionType values](https://developer.mastercard.com/iccp/documentation/05_api_reference/soap_api/reports/create_reports/index.md#clearings-transactiontype-values) <br /> Note: TransactionType does not apply to Clearing decisions. It is only applicable for authorization and clearing. | Yes               | Yes               | Alphabetic   |
| PAN               | * Valid VCN number * VCN to create clearing decisions report for * Length: 12 to 19 digits                                                                                                                                                                                                                                                                                                                                                                                                                 | Yes               | Yes               | Numeric      |

### Authorization TransactionType values {#authorization-transactiontype-values}

|       Name        |                        Description                        |
|-------------------|-----------------------------------------------------------|
| All               | All authorization activities for a VCN.                   |
| Approved          | Approved authorization activities for a VCN.              |
| Partial-Approved  | Partially approved authorization activities for a VCN.    |
| Declined          | Declined authorization activities for a VCN.              |
| Issuer-Declined   | Authorization activities declined by an Issuer for a VCN. |
| Request-Response  | Request authorization activities for a VCN.               |
| Advice-Response   | Advice authorization activities for a VCN.                |
| Reversal-Response | Reversal authorization activities for a VCN.              |

### Clearings TransactionType values {#clearings-transactiontype-values}

|          Name          |                                   Description                                    |
|------------------------|----------------------------------------------------------------------------------|
| All                    | All clearing activities for a VCN.                                               |
| Presentment            | First presentment activities for a VCN.                                          |
| Second Presentment     | Second presentment activities in response to a chargeback for a VCN.             |
| Chargeback             | Chargeback activities in response to a first presentment for a VCN.              |
| Arbitration Chargeback | Arbitration Chargeback activities in response to a second presentment for a VCN. |
| Retrieval Request      | Retrieval activities for a VCN.                                                  |
| Fee Collection         | Fee collection activities for a VCN.                                             |

## Responses {#responses}

For both authorization and clearing calls, the response will indicate if the report create request has been successful, and if so, the ID to use the get the report in a subsequent call.

|      Names      |                                               Description                                               | Required for ICCP | Required for ICMP |     Type     |
|-----------------|---------------------------------------------------------------------------------------------------------|-------------------|-------------------|--------------|
| `ReportId`      | * The id of the created report, which provides report details * Always returned for successful requests | Yes               | No                | Numeric      |
| `SystemMessage` | Always returned for successful requests                                                                 | No                | No                | Alphanumeric |

## Sample request and response {#sample-request-and-response}

### Sample CreateVCNAuthsReportRequest {#sample-createvcnauthsreportrequest}

```xml
<CreateVCNAuthsReportRequest
FromDate="2022-08-22" FromTime="14:15"
ToDate="2022-08-22" ToTime="15:15"
Timezone="Europe/Luxembourg"
TransactionType="All"
Pan="5582351302749637"/>
```

### Sample CreateVCNAuthsReportResponse {#sample-createvcnauthsreportresponse}

```xml
<CreateVCNAuthsReportResponse ReportId="1055" xmlns="http://mastercard.com/sd/pc/service" xmlns:ns2="http://mastercard.com/sd/pc2/service">
         <SystemMessage>Create VCN authorizations report has been submitted.</SystemMessage>
         <errorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</CreateVCNAuthsReportResponse>
```

### Sample CreateVCNClearingsReportRequest {#sample-createvcnclearingsreportrequest}

```xml
<CreateVCNClearingsReportRequest
FromDate="2022-09-04" FromTime="09:00"
ToDate="2022-09-06" ToTime="15:00"
Timezone="Europe/Luxembourg"
TransactionType="All"
Pan="5582351302749637"/>
```

### Sample CreateVCNClearingsReportResponse {#sample-createvcnclearingsreportresponse}

```xml
<CreateVCNClearingsReportResponse ReportId="1069" xmlns="http://mastercard.com/sd/pc/service" xmlns:ns2="http://mastercard.com/sd/pc2/service">
         <SystemMessage>Create VCN clearings report has been submitted.</SystemMessage>
         <errorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</CreateVCNClearingsReportResponse>
```

### Sample CreateVCNClearingExceptionReportRequest {#sample-createvcnclearingexceptionreportrequest}

The VCN Clearing Exception Report allows the user to review exceptions where the clearing amount exceeds the cumulative limit set for a virtual card. This applies only to virtual cards that have a velocity control set for a continuous period.
Note: The `CreateVCNClearingExceptionReportRequest` PAN input field takes only a real card number (RCN) as a value. A user submits a `CreateVCNClearingExceptionReportRequest` and gets a report ID as a response.

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://mastercard.com/sd/pc/service">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:CreateVCNClearingExceptionReportRequest FromDate="2022-07-01" ToDate="2022-07-08" Timezone="US/Pacific" Pan="541275XXXXXX9999"/>
   </soapenv:Body>
</soapenv:Envelope>
```

### Sample CreateVCNClearingExceptionReportResponse {#sample-createvcnclearingexceptionreportresponse}

```xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <CreateVCNClearingExceptionReportResponse ReportId="2123" xmlns="http://mastercard.com/sd/pc/service" xmlns:ns2="http://mastercard.com/sd/pc2/service">
         <SystemMessage>Create VCN clearing summary report has been submitted.</SystemMessage>
         <errorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      </CreateVCNClearingExceptionReportResponse>
   </S:Body>
</S:Envelope>
```

### Sample CreateVCNClearingDecisionsReportRequest {#sample-createvcnclearingdecisionsreportrequest}

The `CreateVCNClearingDecisionsReport` generates a report that lists clearing transactions for the virtual account, along with the decisions made by In Control for each transaction.

```xml
<soapenv:Envelope
   xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:ser="http://mastercard.com/sd/pc/service">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:CreateVCNClearingDecisionsReportRequest
     FromDate="2025-07-01"
     FromTime="00:00"
     ToDate="2025-07-30"
     ToTime="23:59"
     Timezone="US/Pacific"
     Pan="599xxxxxxxxxx772"/>
    </soapenv:Body>
</soapenv:Envelope>
```

### Sample CreateVCNClearingDecisionsReportResponse {#sample-createvcnclearingdecisionsreportresponse}

```xml
<S:Envelope
   xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <CreateVCNClearingDecisionsReportResponse ReportId="15069803"
         xmlns="http://mastercard.com/sd/pc/service"
         xmlns:ns2="http://mastercard.com/sd/pc2/service">
            <SystemMessage>Create VCN Clearing Decisions report has been submitted.</SystemMessage>
            <ErrorMessage xsi:nil="true"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            </CreateVCNClearingDecisionsReportResponse>
        </S:Body>
    </S:Envelope>
```

