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

> Get the authorization or clearing report for a VCN using its report ID. Reports are currently deleted 7 days after creation.

## Parameters {#parameters}

|   Names    |                                                                           Description                                                                            | Required for ICCP | Required for ICMP |  Type   |
|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------|---------|
|            |                                                                                                                                                                  |                   |                   |         |
| `ReportId` | ID of a report obtained from a [Create](https://developer.mastercard.com/iccp/documentation/05_api_reference/soap_api/reports/create_reports/index.md) API call. | Yes               | Yes               | Numeric |
| `From`     | First Transaction to review in the report. Index starts with 0.                                                                                                  | Yes               | Yes               | Numeric |
| `To`       | Last transaction to retrieve the report. Max number of transactions per call is 100.                                                                             | Yes               | Yes               | Numeric |

Note: For additional transactions beyond 100, the `From` value starts after the last `To` value.   
Call 1: 0-99   
Call 2: 100-199 Note: The `GetVCNClearingExceptionReport` returns items for the last settlement date only. While the `GetVCNClearingExceptionReport` includes all authorized transactions it only displays those included for the settlement date the report was ran for. For example if a transaction was authorized in November, and a second transaction is authorized in January, the report run in January will only show transactions with a settlement date of January. The November authorization will not be returned. However both the Clearing and Cumulative amounts will include all transactions.

## Responses {#responses}

For each API request, you receive the following responses.

### Attributes {#attributes}

|   Names   |                                                                                                                 Description                                                                                                                 | Required for ICCP | Required for ICMP |  Type   |
|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------|---------|
|           |                                                                                                                                                                                                                                             |                   |                   |         |
| `HasMore` | * Confirms whether more transactions exist for this report, up to the maximum limit of 50,000. For report queries that exceed the limit, the value returns as 'false' once all 50,000 transactions have been returned * Values: True, False | No                | No                | Boolean |
| `To`      | Last transaction in the report.                                                                                                                                                                                                             | No                | No                | Numeric |
| `From`    | First transaction in the report.                                                                                                                                                                                                            | No                | No                | Numeric |

### AccountSummaryItem attributes {#accountsummaryitem-attributes}

|           Names            |                                                                            Description                                                                             | Required for ICCP | Required for ICMP |     Type     |
|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------|--------------|
| `CpnPan`                   | PAN number                                                                                                                                                         | No                | No                | Numeric      |
| `CurrencyCode`             | ISO currency code of expected currency.                                                                                                                            | No                | No                | Numeric      |
| `CpnType`                  | In Control internal identifier.                                                                                                                                    | No                | No                | Alpha        |
| `LastAuthDate`             | Last authorization date.                                                                                                                                           | No                | No                | Numeric      |
| `SettledUsage`             | Number of cleared settlements for the period defined in the report.                                                                                                | No                | No                | Numeric      |
| `SettledAmount`            | Cleared amount.                                                                                                                                                    | No                | No                | Numeric      |
| `LastSettledDate`          | Cleared amount date.                                                                                                                                               | No                | No                | Numeric      |
| `PreAuthUsage`             | Number of preauthorizations for the period defined in the report.                                                                                                  | No                | No                | Numeric      |
| `CreatedDate`              | Date VCN was created.                                                                                                                                              | No                | No                | Numeric      |
| `CreatedBy`                | ID that created the purchase request.                                                                                                                              | No                | No                | Alpha        |
| `AuthAmount`               | Authorization amount.                                                                                                                                              | No                | No                | Numeric      |
| `AuthUsage`                | Number of authorizations for the period defined in the report.                                                                                                     | No                | No                | Numeric      |
| `PurchaseID`               | Purchase Request ID.                                                                                                                                               | No                | No                | Numeric      |
| `CumulativeLimit`          | Maximum cumulative amount allowed.                                                                                                                                 | No                | No                | Numeric      |
| `PeriodType`               | Only the continuous period value is compared.                                                                                                                      | No                | No                | Alpha        |
| `Company`                  | Company name.                                                                                                                                                      | No                | No                | Alpha        |
| `Supplier`                 | Supplier name. **Note**: This attribute is present but unpopulated for ICMP report results.                                                                        | No                | No                | Alpha        |
| `SpendVLimit`              | Depicts any transactions where the settled amount exceeds the cumulative limit.                                                                                    | No                | No                | Numeric      |
| `CDF1Label`                | The label of the first custom data field.                                                                                                                          | No                | No                | Alphanumeric |
| `CDF1value`                | The value of the first custom data field.                                                                                                                          | No                | No                | Alphanumeric |
| `ICMPUserFirstName`        | The first name of the ICMP end user who is the designated recipient of the virtual card. This attribute is present but unpopulated for non-ICMP report results.    | No                | No                | Alphanumeric |
| `ICMPUserLastName`         | The last name of the ICMP end user who is the designated recipient of the virtual card. This attribute is present but unpopulated for non-ICMP report results.     | No                | No                | Alphanumeric |
| `ICMPUserEmail`            | The email address of the ICMP end user who is the designated recipient of the virtual card. This attribute is present but unpopulated for non-ICMP report results. | No                | No                | Alphanumeric |
| `ICMPUserPhoneCountryCode` | The country code of the ICMP end user's mobile phone number. This attribute is present but unpopulated for non-ICMP report results.                                | No                | No                | Alphanumeric |
| `ICMPUserMobileNumber`     | The ICMP end user's mobile phone number. This attribute is present but unpopulated for non-ICMP report results.                                                    | No                | No                | Numeric      |

### Elements {#elements}

|     Names      |                                                                                                                                         Description                                                                                                                                         | Required for ICCP | Required for ICMP |     Type     |
|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------------|--------------|
| `ReportStatus` | Current status of the report, which is: * **Pending**: Report is under preparation * **Active**: Generated and being processed by ICCP * **Completed**: Processed Successfully * **Failed**: Problem generating a report. Try after some time. Note: ICCP deletes reports after seven days. | No                | No                | Alphanumeric |

### AuthInfos/Transaction/Decision attributes {#authinfostransactiondecision-attributes}

|               Names               |                                                                                                                                                                                         Description                                                                                                                                                                                         | Required |                                                                                                                                                                                                                  Type                                                                                                                                                                                                                   |        Transaction type         |
|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
| `PurchaseRequestId`               | ID of the purchase request used to generate the virtual card.                                                                                                                                                                                                                                                                                                                               | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing/Decision |
| `ClearingDecisionDate`            | Date and time when InControl received and processed the decision on Clearing.                                                                                                                                                                                                                                                                                                               | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `TransactionDate`                 | Date in UTC when InControl processes the transaction, also known as the settlement date.                                                                                                                                                                                                                                                                                                    | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `ClearingDecisionID`              | Unique identifier from InControl for the Clearing Decision.                                                                                                                                                                                                                                                                                                                                 | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `RealCardExpiry`                  | * Expiry month and year of the real card. * Format: YYMM                                                                                                                                                                                                                                                                                                                                    | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `ClearingDecisionCode`            | Numeric code added to the Clearing Decision from In Control to represent the result (approve/deny) and reason.                                                                                                                                                                                                                                                                              | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `ClearingDecisionDescription`     | Text description for the InControl Clearing Decision Code added.                                                                                                                                                                                                                                                                                                                            | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `AuthorizationCode`               | Authorization Code submitted on the Clearing, if present.                                                                                                                                                                                                                                                                                                                                   | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `CardAcceptorId`                  | Merchant ID submitted for the transaction.                                                                                                                                                                                                                                                                                                                                                  | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `TransactionLifecycleId`          | Transaction link identifier submitted on the Clearing record.                                                                                                                                                                                                                                                                                                                               | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `BanknetReference`                | Banknet reference number generated by the network for the transaction.                                                                                                                                                                                                                                                                                                                      | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `RetrievalReferenceNumber`        | Retrieval reference number associated with the Clearing Decision record.                                                                                                                                                                                                                                                                                                                    | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `AcquirerInstitutionId`           | ICA of the Acquirer who submitted the transaction.                                                                                                                                                                                                                                                                                                                                          | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `ForwardingInstitutionId`         | ICA of the forwarding institution who submitted the transaction.                                                                                                                                                                                                                                                                                                                            | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `DestinationInstitutionId`        | ICA of card Issuer who issued the card used to generate the transaction.                                                                                                                                                                                                                                                                                                                    | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `ReceiverInstitutionId`           | ICA of the processor for the issued cards transactions.                                                                                                                                                                                                                                                                                                                                     | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Decision                        |
| `PurchaseRequestStatus`           | Status of the purchase request used to generate the virtual card. -Approved -Blocked -Declined -Cancelled -Pending batch approval -Pending                                                                                                                                                                                                                                                  | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `RealCardAlias`                   | Name of the real card used to generate the virtual card.                                                                                                                                                                                                                                                                                                                                    | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing/Decision |
| `RealCardNumber`                  | Number of the real card used to generate the virtual card.                                                                                                                                                                                                                                                                                                                                  | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing/Decision |
| `VirtualCardNumber`               | Number of the virtual card used for the payment.                                                                                                                                                                                                                                                                                                                                            | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing/Decision |
| `VCNExpiry`                       | * Expiry month and year of virtual card that maps to the real card. * Format: YYMM \</li                                                                                                                                                                                                                                                                                                    | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing/Decision |
| `RequestorName`                   | Name of the user who requested a VCN.                                                                                                                                                                                                                                                                                                                                                       | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing/Decision |
| `BillingAmount`                   | Same as the merchant amount if both billing and merchant currency are same. If not, the amount requested to pay in the billing currency for a merchant amount.                                                                                                                                                                                                                              | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing          |
| `BillingCurrencyCode`             | Three digit currency code of the billing amount.                                                                                                                                                                                                                                                                                                                                            | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `BillingCurrencyCodeDescription`  | Description of the currency code for the billing amount.                                                                                                                                                                                                                                                                                                                                    | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `MerchantAmount`                  | Amount requested by the merchant to pay. This amount is zero for Reversal and Partial Reversal transaction types.                                                                                                                                                                                                                                                                           | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing/Decision |
| `MerchantCurrencyCode`            | Three digit currency code of the merchant amount.                                                                                                                                                                                                                                                                                                                                           | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `MerchantCurrencyCodeDescription` | Description of the currency code for the merchant amount.                                                                                                                                                                                                                                                                                                                                   | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `ClearingType`                    | Credit or Debit based on plus or minus the transaction amount.                                                                                                                                                                                                                                                                                                                              | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Clearing                        |
| `TxnExchangeRate`                 | Currency exchange in operation during a payment.                                                                                                                                                                                                                                                                                                                                            | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `TxnDateTime`                     | Date and time when the transaction was performed.Format: MM-DD hh:mm:ss.000Z.                                                                                                                                                                                                                                                                                                               | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `SettlementDate`                  | Date that In Control processes the settlement or clearing record. Format: YYYY-MM-DD                                                                                                                                                                                                                                                                                                        | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Clearing                        |
| `TxnType`                         | Refer the [TxnType](https://developer.mastercard.com/iccp/documentation/05_api_reference/soap_api/reports/get_reports/index.md#transaction-values) table.                                                                                                                                                                                                                                   | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `TxnSubType`                      | Refer the [TxnSubType](https://developer.mastercard.com/iccp/documentation/05_api_reference/soap_api/reports/get_reports/index.md#transaction-values) table.                                                                                                                                                                                                                                | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization                   |
| `TxnEnvironment`                  | Refer the [TxnEnvironment](https://developer.mastercard.com/iccp/documentation/05_api_reference/soap_api/reports/get_reports/index.md#txnenvironment) table.                                                                                                                                                                                                                                | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization                   |
| `IssuerResponse`                  | Refer the [IssuerResponse](https://developer.mastercard.com/iccp/documentation/05_api_reference/soap_api/reports/get_reports/index.md#issuer-response-values) table.                                                                                                                                                                                                                        | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization                   |
| `InControlResponse`               | Refer the [InControlResponse](https://developer.mastercard.com/iccp/documentation/05_api_reference/soap_api/reports/get_reports/index.md#in-control-response-values) table.                                                                                                                                                                                                                 | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization                   |
| `ApprovalCode`                    | Authorization approval code of the issuer.                                                                                                                                                                                                                                                                                                                                                  | No       | No                                                                                                                                                                                                                                                                                                                                                                                                                                      | Clearing                        |
| `MCC`                             | Merchant category code                                                                                                                                                                                                                                                                                                                                                                      | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing/Decision |
| `MCCDescription`                  | Description of the MCC                                                                                                                                                                                                                                                                                                                                                                      | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing/Decision |
| `MerchantId`                      | Acquired ID of the merchant.                                                                                                                                                                                                                                                                                                                                                                | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `MerchantTerminalId`              | Unique identifier of the merchant terminal.                                                                                                                                                                                                                                                                                                                                                 | No       |                                                                                                                                                                                                                                                                                                                                                                                                                                         | Clearing                        |
| `MerchantName`                    | Name of the merchant providing the good or service.                                                                                                                                                                                                                                                                                                                                         | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing/Decision |
| `MerchantStreetAddress`           | Street address at which the merchant operates.                                                                                                                                                                                                                                                                                                                                              | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Clearing                        |
| `MerchantCity`                    | City in which the merchant operates.                                                                                                                                                                                                                                                                                                                                                        | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `MerchantState`                   | State in which the merchant operates.                                                                                                                                                                                                                                                                                                                                                       | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `MerchantCountryCode`             | Country code in which the merchant operates.                                                                                                                                                                                                                                                                                                                                                | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing/Decision |
| `MerchantCountryCodeDescription`  | Description of the currency code for the merchant amount.                                                                                                                                                                                                                                                                                                                                   | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Clearing/Decision               |
| `MerchantCountry`                 | Country of the merchant providing the good or service.                                                                                                                                                                                                                                                                                                                                      | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization                   |
| `AcquirerICA`                     | Interbank Card Association ID of the acquirer.                                                                                                                                                                                                                                                                                                                                              | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing          |
| `ProcessorICA`                    | Interbank Card Association ID of the processor.                                                                                                                                                                                                                                                                                                                                             | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing          |
| `TerminalId`                      | Unique identifier of the payment control.                                                                                                                                                                                                                                                                                                                                                   | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization                   |
| `Settled`                         | Whether supplier settles the authorization, which is Settled or Unsettled.                                                                                                                                                                                                                                                                                                                  | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization                   |
| `IncontrolIssuerId`               |                                                                                                                                                                                                                                                                                                                                                                                             | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing          |
| `CompanyName`                     | Name of the company to which the VCN belongs to.                                                                                                                                                                                                                                                                                                                                            | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `CompanyNumber`                   | The number of the company to which the VCN belongs to.                                                                                                                                                                                                                                                                                                                                      | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing          |
| `AcquirerReferenceData`           |                                                                                                                                                                                                                                                                                                                                                                                             | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Clearing/Decision               |
| `MessageType`                     | All valid clearing message codes.                                                                                                                                                                                                                                                                                                                                                           | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Clearing                        |
| `FunctionCode`                    |                                                                                                                                                                                                                                                                                                                                                                                             | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Clearing                        |
| `MessageReasonCode`               |                                                                                                                                                                                                                                                                                                                                                                                             | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Clearing                        |
| `SettlementAmount`                |                                                                                                                                                                                                                                                                                                                                                                                             | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Clearing                        |
| `SettlementCurrencyCode`          |                                                                                                                                                                                                                                                                                                                                                                                             | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Clearing                        |
| `SettlementCurrencyDescription`   |                                                                                                                                                                                                                                                                                                                                                                                             | No       | Alphanumeric                                                                                                                                                                                                                                                                                                                                                                                                                            | Clearing                        |
| `TokenPan`                        | Token primary account number (PAN) used for ICMP transactions. For the VCN clearing exception report TokenPan is the count of Token PAN used for ICMP transactions.                                                                                                                                                                                                                         | No       | Numeric                                                                                                                                                                                                                                                                                                                                                                                                                                 | Authorization/Clearing          |
| `TokenRequestorId`                | Unique identifier of the token requestor used for ICMP transactions.                                                                                                                                                                                                                                                                                                                        | No       | Numeric Example: 50146725060                                                                                                                                                                                                                                                                                                                                                                                                            | Authorization/Clearing          |
| `TokenType`                       | Indicates the type of token used in the authorization transaction in ICMP. The field contains two characters: * If the second character contains a space, this indicates that the transaction was mapped using the Mastercard authorization log. * If the second character is C, this indicates that the transaction was mapped using a source other than the Mastercard authorization log. | No       | Alphabetic Values: * C (C space): Mastercard Digital Enablement Service (MDES) secure element device token * CC: MDES secure element device token (mapping based on a different source) * H (H space): MDES cloud-based device token * HC: MDES cloud-based device token (mapping based on a different source) * O (O space): MDES card-on-file device token * OC: MDES card-on-file device token (mapping based on a different source) | Authorization/Clearing          |

### Transaction Values {#transaction-values}

* Authorization
* Advice
* Reversal
* Reversal advice
* Unspecified (Offline Settlements)
* Purchase Return
* Forced Post
* Regular
* PreAuth
* AVS-only
* All
* First Presentment
* Second Presentment (Full)
* Second Presentment (Partial)
* First Chargeback (Full)
* First Chargeback (Partial)
* Arbitration Chargeback (Full)
* Arbitration Chargeback (Partial)
* Retrieval request
* Fee collection
* Regular
* PreAuth
* AVS-only
* Unknown
* POS
* MOTO
* ECOM
* ATM
* PAYPASS
* PWCB

### Issuer response values {#issuer-response-values}

* Approved or completed successfully
* Refer to card issuer
* Invalid merchant
* Capture card
* Do not honor
* Honor with ID
* Partial Approval
* Invalid transaction
* Invalid amount
* Invalid card number
* Invalid issuer
* Format error
* Lost card
* Insufficient funds/over credit limit
* Expired card
* Invalid PIN
* Transaction not permitted to issuer/cardholder
* Transaction not permitted to acquirer/terminal
* Exceeds withdrawal amount limit
* Restricted card
* Security violation
* Exceeds withdrawal count limit
* Contact Card Issuer
* PIN Not Changed
* Allowable number of PIN tries exceeded
* Invalid/nonexistent To Account specified
* Invalid/nonexistent From Account specified
* Invalid/nonexistent account specified (general)
* Domestic Debit Transaction Not Allowed (Regional use only)
* Invalid Authorization Life Cycle
* Not declined
* PIN Validation not possible
* Purchase Amount Only, No Cash Back Allowed
* Cryptographic failure
* Unacceptable PIN - Transaction Declined - Retry
* Authorization Platform or issuer system inoperative
* Unable to route transaction
* Duplicate transmission detected
* System error

### In Control response values {#in-control-response-values}

|               Name               |                                                                                   Description                                                                                   |
|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Approval                         | Transaction within the VCN limits.                                                                                                                                              |
| CPN does not exist               | Invalid VCN, not registered in In Control.                                                                                                                                      |
| Status bad                       | VCN not in an active state. Cannot use for authorizations.                                                                                                                      |
| Expiry match fail                | Expiry provided for the authorization does not match the VCN Expiry.                                                                                                            |
| AVV match fail                   | CVC2 provided for the authorization does not match the VCN CVC2.                                                                                                                |
| Valid period fail                | Transaction falls outside the VCN's defined validity period.                                                                                                                    |
| Trans limit fail                 | Transaction amount greater than the VCN's transaction limit.                                                                                                                    |
| Cumul limit fail                 | Current authorization causes the VCN to breach its cumulative spend limit.                                                                                                      |
| Num usages fail                  | Current authorization causes the VCN to breach its usage.                                                                                                                       |
| Merch Id limit fail              | Merchant Id for authorization does not match the Merchant Id linked to the VCN.                                                                                                 |
| MCC limit fail                   | Merchant Category Code for the authorization does not match the MCC linked to this VCN.                                                                                         |
| Iss/Netwk decline                | Authorization declined by the issuer or card network. Outside of In Control.                                                                                                    |
| Base/CPN conv. Err               |                                                                                                                                                                                 |
| Crit Field Missing               | Critical field missing from the incoming authorization message.                                                                                                                 |
| No Auth for Rev                  | In Control cannot map the reversal to an original.                                                                                                                              |
| Unmatched Response               | Advice does not match any past requests in the authorization journal.                                                                                                           |
| Revl of unsucc auth              | In Control cannot reverse an unsuccessful authorization.                                                                                                                        |
| Exp. Date of CPN used is expired | VCN expired.                                                                                                                                                                    |
| Repeat message                   | Repeat of a previous message. Based on a flag in the message header or on key message fields.                                                                                   |
| Api fail                         |                                                                                                                                                                                 |
| Api System Fail                  |                                                                                                                                                                                 |
| Enhanced MID                     | Acquirer Id (DE32) and Card Acceptor Id (DE42) in the authorization message do not match the values specified for the control.                                                  |
| Enhanced MCC                     | MCC value in the authorization message (D18) does not match the values specified for the control.                                                                               |
| Txn Env Control                  | VCN breached its transaction environment control.                                                                                                                               |
| Err Travel Control               | VCN breached its travel control rule.                                                                                                                                           |
| Multi Merch ID Assoc Lim         | Merchant Id for the authorization does not match any of those linked to this VCN.                                                                                               |
| Single Merch Name Assoc Lim      | Merchant Name for the authorization does not match that linked to this VCN.                                                                                                     |
| Geographic Control               | VCN breached its geographic control rule.                                                                                                                                       |
| Curfew Control                   | VCN breached its curfew control rule.                                                                                                                                           |
| Approve Control                  | VCN breached its approve control rule.                                                                                                                                          |
| RCN Decline                      | Transaction failed due to decline by a subsequent service.                                                                                                                      |
| No Rules Fail                    | Rule set with no rules to evaluate.                                                                                                                                             |
| No Controls Fail                 | Rule with no controls to evaluate.                                                                                                                                              |
| Unknown Control Type Fail        | Cannot classify the control fail.                                                                                                                                               |
| Svc Not Enabled                  | Transaction received for an account with no service enabled.                                                                                                                    |
| Merch Amount Fail                | Transaction amount breaches the expected merchant currency.                                                                                                                     |
| Merch Curr Fail                  | Transaction amount breaches the amount limit for the merchant currency.                                                                                                         |
| DE Control fail                  | Values for DE3.1 -- Processing Code and/or DE22.1 -- PAN Entry Mode and/or61.11 -- POS Term Capability Indicator do not match the values in the authorization.                  |
| EVCN Control fail                | EVCN not in an active state. Cannot use for authorization.                                                                                                                      |
| Roaming VC Fail                  | VCN breaches its roaming velocity control.                                                                                                                                      |
| Amount Range Control Fail        | Transaction amount falls outside the minimum and maximum amount range set.                                                                                                      |
| CPN State Control Fail           | Account suspended. No authorization activity permitted.                                                                                                                         |
| Aging Cumul limit fail           | Control that keeps track of the current remaining Available Credit. Approves transactions only if the requested amount is less than or equal to the remaining Available Credit. |

### In Control Clearing Decision values {#in-control-clearing-decision-values}

| Clearing Decision Code |       Clearing Decision Description       |                                               Decision Details                                               |
|------------------------|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| 0                      | Approval                                  | Approved by In Control, as clearing within the VCN limits.                                                   |
| 48                     | `Ageing_Cumul_limit_fail`                 | Rejected by In Control, as clearing causes the VCN to breach its Ageing Velocity limit                       |
| 74                     | `CLEARING_CONTROLS_MCC_LIMIT_FAIL`        | Rejected by In Control, as Merchant Category Code for the clearing does not match the MCC linked to this VCN |
| 75                     | `CLEARING_CONTROLS_CUMULATIVE_LIMIT_FAIL` | Rejected by In Control, as clearing causes the VCN to breach its cumulative spend limit                      |
| 76                     | `CLEARING_CONTROLS_NOT_APPLICABLE`        | Clearing Controls not applied on transaction by In Control                                                   |
| 77                     | `CLEARING_CONTROLS_MERCH_CURR_FAIL`       | Rejected by In Control, as transaction currency does not match the Merchant Currency setup on VCN            |

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

### Sample GetVCNAuthsReportRequest {#sample-getvcnauthsreportrequest}

```xml
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:ser="http://mastercard.com/sd/pc/service">
 <soapenv:Header/>
 <soapenv:Body>
  <ser:GetVCNAuthsReportRequest
     From="1"
     ReportId="1000"
     To="10"/>
 </soapenv:Body>
</soapenv:Envelope>
```

### Sample GetVCNAuthsReportResponse (ICMP not enabled) {#sample-getvcnauthsreportresponse-icmp-not-enabled}

```xml
<GetVCNAuthsReportResponse HasMore="false" To="10" From="1" xmlns="http://mastercard.com/sd/pc/service" 
xmlns:ns2="http://mastercard.com/sd/pc2/service">
   <ReportStatus>Completed</ReportStatus>
   <AuthInfos CompanyNumber="100001"
      CompanyName="ABC Company"
      IncontrolIssuerId="1"
      Settled="Unsettled"
      TerminalId="77891137"
      ProcessorICA="322222"
      AcquirerICA="777777"
      MerchantCountry="United Kingdom"
      MerchantCountryCode="826"
      MerchantName="111"
      MerchantId="111111111111111"
      MCCDescription="AUTOTRUCK DLRS-SALES, SVC, REPRS, PRTS, LEASING"
      MCC="5511"
      InControlResponse="MCC limit fail"
      IssuerResponse="Do not honor"
      TxnEnvironment="ECOM"
      TxnSubType="Regular"
      TxnType="Authorization"
      TxnDateTime="06-10"
      MerchantCurrencyCodeDescription="EURO CURRENCY UNIT"
      MerchantCurrencyCode="EUR"
      MerchantAmount="35.76"
      BillingCurrencyCodeDescription="U.S. DOLLAR"
      BillingCurrencyCode="USD"
      BillingAmount="35.76"
      RequestorName="abcCorp1"
      VCNExpiry="1705"
      VirtualCardNumber="XXXX-XXXX-XXXX-1000"
      RealCardNumber="XXXX-XXXX-XXXX-4000"
      RealCardAlias="Alias1"
      PurchaseRequestId="100"
      PurchaseRequestStatus="Cancelled"/>
      <ErrorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"/>
      </GetVCNAuthsReportResponse>
```

### Sample GetVCNAuthsReportResponse (ICMP enabled) {#sample-getvcnauthsreportresponse-icmp-enabled}

```xml
<GetVCNAuthsReportResponse 
From="0" HasMore="false" To="2" 
xmlns="http://mastercard.com/sd/pc/service" xmlns:ns2="http://mastercard.com/sd/pc2/service">
<ReportStatus>Completed</ReportStatus>
<AuthInfos 
    BillingAmount="0.00" 
    CompanyName="AutomationComp" 
    CompanyNumber="112233" 
    ICMPUserEmail="first.last@domain.com" 
    ICMPUserFirstName="first" 
    ICMPUserLastName="last" 
    ICMPUserMobileNumber="204567890" 
    ICMPUserPhoneCountryCode="+1" 
    InControlResponse="Approval" 
    IncontrolIssuerId="1" 
    MerchantAmount="0.00" 
    PurchaseRequestId="91055" 
    PurchaseRequestStatus="Approved" 
    RealCardAlias="testReports" 
    RealCardNumber="XXXX-XXXX-XXXX-2470" 
    RequestorName="Automation_CPA" 
    Settled="Unsettled" 
    TokenPAN="XXXX-XXXX-XXXX-2911" 
    TokenRequestorId="50146725060" 
    TokenType="F" 
    TxnDateTime="10-28" 
    TxnDateTimeWithTime="10-28T09:41:03.000Z" 
    VCNExpiry="2610" 
    VirtualCardNumber="XXXX-XXXX-XXXX-2100"/>
<ErrorMessage xsi:nil="true" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</GetVCNAuthsReportResponse>
```

### Sample GetVCNClearingsReport {#sample-getvcnclearingsreport}

```xml
<GetVCNClearingsReport From="1" ReportId="1000" To="10"/>
```

### Sample GetVCNClearingsReportResponse (ICMP not enabled) {#sample-getvcnclearingsreportresponse-icmp-not-enabled}

```xml
<GetVCNClearingsReportResponse HasMore="false" To="1" From="0" xmlns="http://
mastercard.com/sd/pc/service" xmlns:ns2="http://mastercard.com/sd/pc2/service">
  <ReportStatus>Completed</ReportStatus>
   <Transactions CompanyNumber="100001"
      CompanyName="ABC Company"
      SettlementCurrencyDescription="U.S. DOLLAR"
      SettlementCurrencyCode="840"
      SettlementAmount="20.0"
      MessageReasonCode="1401"
      FunctionCode="200"
      MessageType="1240.0"
      AcquirerReferenceData="00382299507007100011481"
      InControlIssuerId="1"
      ProcessorICA="322222"
      AcquirerICA="111111"
      MerchantCountryCodeDescription="UNITED STATES"
      MerchantCountryCode="840"
      MerchantPostalCode="123"
      MerchantCity="TEST CITY"
      MerchantName="AAAAAAA"
      MerchantTerminalId="12345678"
      MerchantId="111111111111111111111"
      MCCDescription="OFFICE AND COMMERCIAL FURNITURE"
      MCC="5021"
      ApprovalCode="111111"
      TxnType="First Presentment"
      SettlementDate="2015-06-10"
      TxnDateTime="06-10"
      TxnExchangeRate="1"
      MerchantCurrencyCodeDescription="U.S. DOLLAR"
      MerchantCurrencyCode="USD"
      MerchantAmount="150.0"
      BillingCurrencyCodeDescription="U.S. DOLLAR"
      BillingCurrencyCode="USD"
      BillingAmount="150.0"
      Requestor="system"
      VirtualCardNumber="XXXX-XXXX-XXXX-2720"
      RealCardNumber="XXXX-XXXX-XXXX-4000"
      RealCardAlias="Gounder"
      PurchaseRequestId="855"
      PurchaseRequestStatus="Cancelled"/>
   <ErrorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"/>
</GetVCNClearingsReportResponse>
```

### Sample GetVCNClearingsReportResponse (ICMP enabled) {#sample-getvcnclearingsreportresponse-icmp-enabled}

```xml
<GetVCNClearingsReportResponse 
From="0" HasMore="false" To="2" 
xmlns="http://mastercard.com/sd/pc/service" xmlns:ns2="http://mastercard.com/sd/pc2/service">
<ReportStatus>Completed</ReportStatus>
<Transactions 
    AdditionalMerchantName="" 
    CompanyName="AutomationComp" 
    CompanyNumber="112233" 
    ICMPUserEmail="first.last@domain.com"
    ICMPUserFirstName="first"
    ICMPUserLastName="last"
    ICMPUserMobileNumber="204567890" 
    ICMPUserPhoneCountryCode="+1" 
    InControlIssuerId="1" 
    PurchaseRequestId="91055" 
    PurchaseRequestStatus="Approved" 
    RealCardAlias="testReports" 
    RealCardNumber="XXXX-XXXX-XXXX-2470" 
    Requestor="Automation_CPA" 
    SettlementDate="2024-10-28T10:44:14.000Z" 
    TokenPAN="XXXX-XXXX-XXXX-2913" 
    TokenRequestorId="50146725060" 
    TokenType="F" 
    TxnDateTime="2024-10-28T10:44:14.000Z" 
    VirtualCardNumber="XXXX-XXXX-XXXX-2100"/>
<ErrorMessage xsi:nil="true" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</GetVCNClearingsReportResponse>
```

### Sample GetVCNClearingExceptionReportRequest {#sample-getvcnclearingexceptionreportrequest}

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ser="http://mastercard.com/sd/pc/service">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:GetVCNClearingExceptionReportRequest ReportId="2123" From="1" To="3"/>
   </soapenv:Body>
</soapenv:Envelope>
```

### Sample GetVCNClearingExceptionReportResponse (ICMP not enabled) {#sample-getvcnclearingexceptionreportresponse-icmp-not-enabled}

```xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <GetVCNClearingExceptionReportResponse From="1" To="4" HasMore="false" 
      xmlns="http://mastercard.com/sd/pc/service" xmlns:ns2="http://mastercard.com/sd/pc2/service">
         <ReportStatus>Completed</ReportStatus>
         <AccountSummaryItem 
            CpnPan="5582351753081639" 
            CurrencyCode="840" 
            CpnType="MA" 
            SettledUsage="1" 
            SettledAmount="50" 
            LastSettledDate="2022-09-26 16:31:26.00 +0000" 
            PreAuthUsage="1" 
            CreatedDate="2022-09-26" 
            UpdatedDate="2022-09-29" 
            CreatedBy="Teste" 
            AuthAmount="50" 
            AuthUsage="1" 
            PurchaseId="16812" 
            CumulativeLimit="10" 
            PeriodType="C" 
            Company="ICCP Company" 
            Supplier="ICCP Supplier" 
            SpendVLimit="-40" 
            CDF1Label="Purchase Type" 
            CDF1Value="P0000167671Airlines" 
            CDF2Label="CDF1" 
            CDF2Value="csd" 
            CDF3Label="CDF3" 
            CDF3Value="VALUEVALUEVALUEVALUEVALUEVALUEVALUEVALUE" 
            CDF4Label="CDF4" 
            CDF4Value="cfadsf" 
            CDF5Label="CDF5" 
            CDF5Value="csfdsf" />
         <ErrorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      </GetVCNClearingExceptionReportResponse>
   </S:Body>
</S:Envelope>
```

### Sample GetVCNClearingExceptionReportResponse (ICMP enabled) {#sample-getvcnclearingexceptionreportresponse-icmp-enabled}

```xml
GetICMPVCNClearingExceptionReportRequest=<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>
   <ns2:GetVCNClearingExceptionReportResponseFrom="1"To="31"HasMore="false"xmlns="http://mastercard.com/sd/pc2/service"xmlns:ns2="http://mastercard.com/sd/pc/service">
      <ns2:ReportStatus>Completed</ns2:ReportStatus>
         <ns2:AccountSummaryItem
            CpnPan="5995020080494804"
            CurrencyCode="826"
            CpnType="MA"
            SettledUsage="1"
            SettledAmount="10"
            LastSettledDate="2023-05-1007:22:39.00+0000"
            PreAuthUsage="1"
            CreatedDate="2023-05-10"
            CreatedBy="AnitaCPA2"
            AuthAmount="10"
            AuthUsage="1"
            PurchaseId="5274604"
            CumulativeLimit="100"
            PeriodType="C"
            Company="AnitaCompany1"
            Supplier="AG_Supplier2"
            SpendVLimit="90"
            CDF1Label="PurchaseType"
            CDF1Value="P0000000587Rail"/>
         <ns2:AccountSummaryItem
            CpnPan="5995025614181132"
            CurrencyCode="826"
            CpnType="MA"
            SettledUsage="1"
            SettledAmount="11"
            LastSettledDate="2023-05-1007:25:58.00+0000"
            PreAuthUsage="1"
            CreatedDate="2023-05-10"
            CreatedBy="AnitaCPA2"
            AuthAmount="11"AuthUsage="1"
            PurchaseId="5274616"
            CumulativeLimit="100"
            PeriodType="C"
            Company="AnitaCompany1"
            SpendVLimit="89"
            CDF1Label="PurchaseType"
            CDF1Value="P0000002741Airlines"
            ICMPUserFirstName="first"
            ICMPUserLastName="last"
            ICMPUserEmail="first.last@domain.com"
            ICMPUserPhoneCountryCode="+11"
            ICMPUserMobileNumber="1111111111"
            TokenPan="3"/>
      <ns2:ErrorMessagexsi:nil="true"xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"/></
ns2:GetVCNClearingExceptionReportResponse>
```

### Sample GetVCNClearingDecisionsReportRequest {#sample-getvcnclearingdecisionsreportrequest}

The `GetVCNClearingDecisionsReport` retrieves a report that was generated through the `CreateVCNClearingDecisions` request.  

The maximum number of transactions that you can return for a report query is 50,000. If the `GetVCNClearingDecisionsReportResponse` includes 50,000 transactions, then there may be additional transactions for the date range queried. In this case, submit a new `CreateVCNClearingDecisionsReportRequest` with an adjusted date range, followed by a `GetVCNClearingDecisionsReportRequest`.  

This approach ensures that you can include all of your transactions, even if multiple queries are required.

```xml
<soapenv:Envelope
   xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:ser="http://mastercard.com/sd/pc/service">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:GetVCNClearingDecisionsReportRequest
     ReportId="15069803"
     From="1"
     To="50000"/>
    </soapenv:Body>
</soapenv:Envelope>
```

### Sample GetVCNClearingDecisionsReportResponse {#sample-getvcnclearingdecisionsreportresponse}

```xml
<S:Envelope
   xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <GetVCNClearingDecisionsReportResponse From="1" HasMore="false" To="50000"
      xmlns="http://mastercard.com/sd/pc/service"
      xmlns:ns2="http://mastercard.com/sd/pc2/service">
            <ReportStatus>Completed</ReportStatus>
            <Transactions AcquirerInstitutionId="11111111111"
         AcquirerReferenceData="85177494310007857467934"
         AuthorizationCode="04708Z"
         BanknetReference="9F9CCB"
         CardAcceptorId="393672100790633"
         ClearingDecisionCode="0"
         ClearingDecisionDate="2025-07-31 06:18:10"
         ClearingDecisionDescription="Approval"
         ClearingDecisionID="3b280859-db1f-091d-e063-e8459e0a2e14"
         DestinationInstitutionId="12121212121"
         ForwardingInstitutionId="00000001141"
         ICMPUserEmail=""
         ICMPUserFirstName=""
         ICMPUserLastName=""
         ICMPUserMobileNumber=""
         ICMPUserPhoneCountryCode=""
         MCC="3007"
         MCCDescription="AIR FRANCE"
         MerchantAmount="15.00"
         MerchantCurrencyCode="GBP"
         MerchantCurrencyCodeDescription="POUND STERLING"
         MerchantName="THE OAK KITCHEN BAKERY"
         PurchaseRequestId="20541097"
         RealCardAlias="ClearingDecision"
         RealCardExpiry="4412"
         RealCardNumber="XXXX-XXXX-XXXX-7360"
         ReceiverInstitutionId="12312312300"
         RequestorName="cpa xyz"
         RetrievalReferenceNumber="012345678901"
         TransactionDate="2024-11-05"
         TransactionLifecycleId="Ldaiuq6hZjdbZ2HUbsw89"
         VirtualCardExpiry="2707"
         VirtualCardNumber="XXXX-XXXX-XXXX-4772"/>
            <ErrorMessage xsi:nil="true"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
        </GetVCNClearingDecisionsReportResponse>
     </S:Body>
    </S:Envelope>
```

