# SOAP Error Handling
source: https://developer.mastercard.com/iccp/documentation/error_handling/06error_codes/index.md

> Ensure that your application handles the different types of errors that your application may encounter when accessing the ICCP API.

## Introduction {#introduction}

In the first instance, errors are indicated through the HTTP status codes in accordance with the HTTP specification. If you receive a HTTP error status in a response, review the error information to determine how to resolve the error.

If the HTTP response has a success status (200 series), then it is still important to check the message payload for any error information.

An error message contains a *fault* or *errorMessage* element in a response body with the error content. There are two types of error messages:

* Error messages from the API Gateway including communication errors and request validation errors.
* ICCP Application errors specific to the operation you are performing.

## XML Gateway Error Messages {#xml-gateway-error-messages}

Mastercard's API Gateway may return errors in response to your requests, including communication errors, authentication issues, and errors in the request structure.
The XML Gateway errors and how to respond to them are documented at [this page](https://developer.mastercard.com/platform/documentation/gateway-error-codes/).

## Timeout Errors {#timeout-errors}

In case of a communication failure between a client application and Mastercard, the client API request timeout. In this case, retry your request at intervals until the request succeeds.

* Because Mastercard has implemented timeouts and retries in its network, the client application should wait a minimum of 30 seconds before timing out and retrying the requests. ^[1](https://developer.mastercard.com/iccp/documentation/error_handling/06error_codes/index.md#fn:1)^{#fnref:1}
* Failure to wait before timing out the request may result in your request completing without your application being aware of it. For a create or update request, your application would then be out of sync.

## Message Format Errors {#message-format-errors}

Incorrectly formatted API requests may receive an error such as the following:

* XML schema validation failed
* Message signature validation failed

In each case, use the error details returned and the information in this guide to determine the source of the error and retry the request.

## System Unavailable Errors {#system-unavailable-errors}

If ICCP API was unable to complete your API request due to a temporary problem, the Mastercard network responds with an appropriate error.

Retry your request at intervals, until your request succeeds. Wait 30 seconds between the retries. Ensure that not more than 10 retry requests are pending at any time.

## ICCP Application Errors {#iccp-application-errors}

An API request may fail with an ICCP application error. As a result, the ICCP API returns an `errorMessage` element with an error code and a description in the response body. For application errors due to incorrect request parameters, resend the requests with corrected parameters.

For errors that indicate a temporary failure, retry your request at intervals, until your request succeeds. Wait 30 seconds between the retries. Ensure not more than 10 retry requests are pending at any time.

## Use of Correlation ID {#use-of-correlation-id}

When retrying a request, if you are sending a correlation ID, use the same correlation ID that was used in the original request. This assists in troubleshooting, if needed.

## errorMessage Elements {#errormessage-elements}

|        Name        | Required (ICCP) |     Type     | Comment | Error Codes |
|--------------------|-----------------|--------------|---------|-------------|
| `errorCode`        | N               | Alphanumeric |         |             |
| `errorDescription` | N               | Alphanumeric |         |             |
| `errorMessage`     | N               | Alphanumeric |         |             |

## List of Codes {#list-of-codes}

All API errors have a specific code and description to enable API callers to understand the source of the error.

|      Code       |                                                                                     Description                                                                                     |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ECGI            | Unable to add Addenda records to a canceled Purchase Request.                                                                                                                       |
| EDGI            | Unable to delete Addenda records for a canceled Purchase Request.                                                                                                                   |
| EDGI            | Request cannot be processed; no addenda records.                                                                                                                                    |
| EMCRE           | The maximum number of records has been exceeded.                                                                                                                                    |
| ERGI            | Unable to retrieve Addenda records for a canceled Purchase Request.                                                                                                                 |
| ERGI            | Request cannot be processed; no addenda records.                                                                                                                                    |
| ERGI            | Request cannot be processed; Invoice Addenda is not enabled.                                                                                                                        |
| ERGI            | An unexpected error occurred while retrieving global invoice(s).                                                                                                                    |
| EUGI            | Unable to add Addenda records to a cancelled Purchase Request.                                                                                                                      |
| EUGI            | Request cannot be processed; no addenda records.                                                                                                                                    |
| RFIE            | Error during retrieving a report.                                                                                                                                                   |
| SCC             | There was a problem TRYING TO Sync Card Currency.                                                                                                                                   |
| SCDF            | There was a problem saving the custom data fields for the update request.                                                                                                           |
| SVR             | There was a problem saving the vcn request.                                                                                                                                         |
| UVR             | There was a problem updating the vcn request.                                                                                                                                       |
| VALPR           | Cannot delete addenda records. The maximum number of records per request has been exceeded.                                                                                         |
| VACAT0 (VACVE)  | An unexpected general error occurred. Please try again later.                                                                                                                       |
| VACAT01 (VACVE) | Please review your request details and try again. If the problem persists, please contact your system administrator.                                                                |
| VACAT06 (VACVE) | An unexpected internal communication error occurred (cert validation). Please try again later.                                                                                      |
| VACCN6 (VACVE)  | Please review your request details and try again. If the problem persists please contact your system administrator.                                                                 |
| VACIED          | Invalid Expiry Date Requested.                                                                                                                                                      |
| VACMRC          | Unable to correctly analyze a purchase request which did not have required controls present.                                                                                        |
| VACOIL (VACVE)  | Internal Server Error. Please try again later.                                                                                                                                      |
| VACOIL4 (VACVE) | Error allocating the virtual card. Please try again later.                                                                                                                          |
| VACPL2 (VACVE)  | Invalid real card, number does not exist. Please make sure that the real card is in a valid status.                                                                                 |
| VACPL7 (VACVE)  | Invalid real card, number does not exist. Please make sure that the real card is in a valid status.                                                                                 |
| VACTM2 (VACVE)  | Please review your request details and try again. If the problem persists, please contact your system administrator.                                                                |
| VACTM3 (VACVE)  | Please review your request details and try again. If the problem persists, please contact your system administrator.                                                                |
| VACVE           | There was a problem allocating the VCN.                                                                                                                                             |
| VACVEG          | There was a problem allocating the VCN. Please retry for GEN0002.                                                                                                                   |
| VAGTMAR         | The Amount must be less than the max amount range.                                                                                                                                  |
| VAIFI           | fromIndex invalid. fromIndex cannot be greater than the number of addenda records.                                                                                                  |
| VALPR           | Cannot add addenda records. The maximum number of records per request has been exceeded.                                                                                            |
| VAPPRPR         | Request cannot be processed; Purchase Request is not approved.                                                                                                                      |
| VAPPRPR         | Request cannot be processed; Purchase Request is cancelled.                                                                                                                         |
| VAR             | The Amount Range Control was missing from the request.                                                                                                                              |
| VARCT           | Currency Type setting has been locked to \[value\] by the Issuer/Company.                                                                                                           |
| VCANPRAC        | Unable to cancel a previously cancelled purchase request.                                                                                                                           |
| VCANPRCBC       | A Straight Through Processing purchase request cannot be cancelled.                                                                                                                 |
| VCANPRPRC       | Purchase Request(s) could not be canceled.                                                                                                                                          |
| VCANPRUC        | Unable to cancel the purchase request; invalid request ID provided.                                                                                                                 |
| VCDF            | One of the required Custom Data Fields did not match the format requirements, field name:*{field name}*.                                                                            |
| VCDFCL          | The combined length of all the custom data fields should not exceed 3500 characters.                                                                                                |
| VCDFA           | The value has non alpha characters for custom field named: \[field name\].                                                                                                          |
| VCDFAN          | Please correct the malformed character in the CDF field: + CDF field name.                                                                                                          |
| VCDFDT          | The value is not in the correct date format for custom field named: \[field name\].                                                                                                 |
| VCDFL           | The length is too long for the custom data field named: \[field\].                                                                                                                  |
| VCDFLE          | The value is not present in the predefined list for custom field named: \[field name\].                                                                                             |
| VCDFN           | The value has non numeric characters for custom field named: \[field\].                                                                                                             |
| VCF             | One of the required Custom Data Fields was missing from the request. field name: \[field\].                                                                                         |
| VCI             | The Company Id was missing from the request.                                                                                                                                        |
| VCM             | There was a problem retrieving the RCN Data with rcnId : \[rcnID\].                                                                                                                 |
| VCR             | There was a problem assigning rules to your VCN Request.                                                                                                                            |
| VD              | Invalid date {date given}.\[valid date format YYYY-MM-DD\].                                                                                                                         |
| VDI             | The DataSource Id is missing from the request.                                                                                                                                      |
| VDR             | FromDate must be equal to or before ToDate.                                                                                                                                         |
| VDRNE           | The report date range cannot exceed 31 days.                                                                                                                                        |
| VDRSBSM         | Date range should be same month.                                                                                                                                                    |
| VDVR            | There was a problem in deleting a VCN.                                                                                                                                              |
| VDY             | The Validity Control was missing from the request.                                                                                                                                  |
| VELCM           | There was a problem retrieving the RCN Data with rcnId:.                                                                                                                            |
| VELIVCF         | An invalid velocity control field exists in the request. field name:.                                                                                                               |
| VEMPTYRQCDF     | The Required Custom Data Field was empty : field.                                                                                                                                   |
| VFL             | The field value exceeds the field's defined length \[Field\].                                                                                                                       |
| VFPGFU          | A purchase group is not found.                                                                                                                                                      |
| VFTRD           | Only one instance of FullTemplateRuleDetails is allowed per purchase request.                                                                                                       |
| VGAFGT          | The from index amount exceeds the to index.                                                                                                                                         |
| VGCANF          | The RCN Alias entered was not found for the specified company.                                                                                                                      |
| VGCDF           | There was a problem getting the CDF to get the order.                                                                                                                               |
| VGCGRC          | There was a problem getting the real cards for the company entered.                                                                                                                 |
| VGCID           | There was a problem getting the Card Image Data.                                                                                                                                    |
| VGCRCN          | There was a problem retrieving the RCN Data with rcnId :.                                                                                                                           |
| VGD             | There was a problem getting the DataSources for the given issuer.                                                                                                                   |
| VGIID           | There was a problem getting the issuer id for the company id provided.                                                                                                              |
| VGLS            | There was a problem getting the Lodging Summary for the request.                                                                                                                    |
| VGR             | There was a problem getting the VCN Request.                                                                                                                                        |
| VGRCND          | There was a problem getting RCN details.                                                                                                                                            |
| VGRD            | There was a problem getting the Rail Detail for the request.                                                                                                                        |
| VGRFD           | There was a problem getting the custom data fields for the given request id.                                                                                                        |
| VGS             | There was a problem getting the companies for the given issuer id and corp number.                                                                                                  |
| VGSBN           | There was a problem getting the supplier by a supplier name.                                                                                                                        |
| VGSBNE          | There was a problem getting the supplier email address by a supplier id.                                                                                                            |
| VGSEA           | There was a problem getting the supplier email address by a supplier id.                                                                                                            |
| VGSU            | There was a problem getting the suppliers for the company ID provided.                                                                                                              |
| VGSU            | Request cannot be processed; An email address does not exist for this supplier.                                                                                                     |
| VGTA            | There was a problem getting the Travel Agency Detail for the request.                                                                                                               |
| VGTC            | There was a problem getting the Tolerances for the given corpId.                                                                                                                    |
| VGTCDF          | There was a problem getting the Template CDF to get the order.                                                                                                                      |
| VGTL            | There was a problem getting the Air Detail for the request.                                                                                                                         |
| VGVR            | There was a problem getting the Vehicle Rental Detail for the request.                                                                                                              |
| VICMPGEN        | The ICMP flow and the request could not be completed.                                                                                                                               |
| VIII            | In Control Issuer ID is missing.                                                                                                                                                    |
| VINTGR          | You do not have access to that corporation.                                                                                                                                         |
| VMA             | The Merchant Amount Control was missing from the request.                                                                                                                           |
| VMLFDTL         | SequenceNumber was too long, maximum length is 2.                                                                                                                                   |
| VMRFDTL         | The Rail Detail addendum was missing a required field. - field:.                                                                                                                    |
| VMXFR           | Max Free Miles is required if Rate Per Mile is given.                                                                                                                               |
| VNIMAR          | The request id given did not match any of our records.                                                                                                                              |
| VNISR           | There was a problem saving the VCN request information.                                                                                                                             |
| VOTNMBR         | The original ticket number is required when sending the exchange ticket information.                                                                                                |
| VPC             | There was not a Purchase Template with the given Id, \[template ID\].                                                                                                               |
| VPCCA           | The corporation Id given is not active in our system.                                                                                                                               |
| VPCCAER         | There was a problem validating the corporation Id.                                                                                                                                  |
| VPCPT           | The Purchase Type with the given Purchase Template is inactive. Purchase Template Name: *{template name}*.                                                                          |
| VPRCHRQID       | The Purchase Request Id entered was invalid.                                                                                                                                        |
| VPRIA           | Missing or invalid addenda.                                                                                                                                                         |
| VPRII           | Missing or invalid Id.                                                                                                                                                              |
| VPRIVCND        | The VCN Delivery Method is not within the acceptable parameters.                                                                                                                    |
| VPRMVCND        | The VCN Delivery Method is not provided.                                                                                                                                            |
| VPT             | There was a problem in getting a purchase type.                                                                                                                                     |
| VRA             | The RCN ALIAS was missing from the request.                                                                                                                                         |
| VRCNL           | The RCN ID is an invalid length.                                                                                                                                                    |
| VRI             | The RCN ID was missing from the request.                                                                                                                                            |
| VRID            | Invalid report id.                                                                                                                                                                  |
| VRNDII          | The RCN Data is invalid.                                                                                                                                                            |
| VRNINA          | The RCN is inactive.                                                                                                                                                                |
| VRNMFR          | The RCN Data was missing from the request.                                                                                                                                          |
| VRNNAPG         | The RCN is not assigned to the purchase group of the purchase request.                                                                                                              |
| VRNSPGA         | Requests can only be submitted for a Purchase Group with the status of Active.                                                                                                      |
| VRR             | Invalid report range.                                                                                                                                                               |
| VSE             | There was a problem saving the request and response.                                                                                                                                |
| VSMN            | Request cannot be processed; Supplier is not enabled to receive emails.                                                                                                             |
| VSPRIARF        | An invalid amount range control field exists in the request. field name:.                                                                                                           |
| VSPRIAVF        | An invalid aging velocity control field exists in the request. field name:.                                                                                                         |
| VSPRICCF        | An invalid curfew control field exists in the request. field name:.                                                                                                                 |
| VSPRICT         | An invalid control type exists in the request type:.                                                                                                                                |
| VSPRIFM         | The valid for months must be 1 to 24 months.                                                                                                                                        |
| VSPRIGCF        | An invalid geography control field exists in the request. field name:.                                                                                                              |
| VSPRIMI         | Negate is the only supported attribute; Merchant and Acquirer details should be specified in Supplier Setup.                                                                        |
| VSPRINPG        | Integrator is not in purchase group.                                                                                                                                                |
| VSPRINV         | Valid For cannot contain a negative value.                                                                                                                                          |
| VSPRIRN         | The purchase request rules must have unique rule names.                                                                                                                             |
| VSPRIS          | Request cannot be processed; Invalid or inactive supplier.                                                                                                                          |
| VSPRISF         | An invalid supplier field exists in the request. field name:.                                                                                                                       |
| VSPRITCF        | An invalid travel control field exists in the request. field name:.                                                                                                                 |
| VSPRITDCF       | An invalid time of day control field exists in the request. field name:.                                                                                                            |
| VSPRITLCF       | An invalid transaction limit control field exists in the request. field name:.                                                                                                      |
| VSPRIVCF        | An invalid validity control field exists in the request. field name:.                                                                                                               |
| VSPRIVECF       | An invalid velocity control field exists in the request. field name:.                                                                                                               |
| VSPRMD          | Description is required for a Company VCN Request.                                                                                                                                  |
| VSPRMMIC        | Only one Merchant Id control is allowed.                                                                                                                                            |
| VSPRMR          | The purchase request must have rules.                                                                                                                                               |
| VSPRMRN         | The purchase request rules must have a rule name.                                                                                                                                   |
| VSPRMSC         | The specified supplier has not been configured to use the Merchant ID control.                                                                                                      |
| VSPRMSD         | The supplierDetails field is missing from the request.                                                                                                                              |
| VSPRMTSSE       | Cannot have more than 6 supplier emails.                                                                                                                                            |
| VSPRMVNA        | Cannot have multiple velocity controls in the request with the same period.                                                                                                         |
| VSPRNVU         | A request submitter is not valid user.                                                                                                                                              |
| VSPRSSS         | In the Supplier Set up screen, you must enable "Allow VCN requestor to manually enter a new email address when requesting a VCN".                                                   |
| VSPRSUVVC       | The Issuer/Company has locked purchase requests to have a single use, therefore the Purchase Request control must be Velocity with Continuous period and max transactions set to 1. |
| VSRFD           | There was a problem saving the custom data fields for the allocate vcn request.                                                                                                     |
| VT              | Invalid time 06-00. \[Valid time format is HH:mm. FromTime and ToTime must be between 00:00 and 23:59\].                                                                            |
| VTDMPT          | There was not a Purchase Template with the given Id, Id:.                                                                                                                           |
| VTDNAAA         | The request's Purchase Template is not associated with the active auto approve purchase group.                                                                                      |
| VTDNAPG         | The Purchase Template must be assigned to an active purchase group.                                                                                                                 |
| VTDPGT          | There was a problem getting the template detail for the template ID submitted.                                                                                                      |
| VTDPTI          | The Purchase Template with the given id is inactive. Id:.                                                                                                                           |
| VTL             | There was a problem gathering the purchase template list.                                                                                                                           |
| VTM             | Total Miles is required if Rate Per Mile is given.                                                                                                                                  |
| VTMPLTCRPID     | The template does not belong to the given companyId.                                                                                                                                |
| VTRVLDT         | The travel date entered is invalid. It must be day and month in the format DDMON, e.g. 12JAN.                                                                                       |
| VTT             | Invalid Transaction Type.                                                                                                                                                           |
| VTR             | FromTime must be equal to or before ToTime.                                                                                                                                         |
| VTXMNA          | There was a problem updating the vcn request.                                                                                                                                       |
| VTXPSV          | There was a problem saving the VCN Financial Transaction.                                                                                                                           |
| VTZ             | Invalid time zone.                                                                                                                                                                  |
| VUADPSA         | There was a problem saving the Custom Data fields or data Addenda Data.                                                                                                             |
| VUADPUA         | There was a problem updating the addenda Data.                                                                                                                                      |
| VUD             | Unit of Distance is required if Rate Per Mile is given.                                                                                                                             |
| VUPRCBM         | A Straight Through Processing purchase request cannot be modified.                                                                                                                  |
| VUPRIPI         | The Purchase Request Id entered was invalid.                                                                                                                                        |
| VUPRITI         | The template id is invalid.                                                                                                                                                         |
| VUPRIUDCCF      | When `ICMPUserPhoneCountryCode` is not within the acceptable parameters, this error is returned.                                                                                    |
| VUPRIUEF        | An invalid UserDetails field exists in the request. field name: email.                                                                                                              |
| VUPRIUMF        | When `ICMPUserMobileNumber` is not within the acceptable parameters, this error is returned.                                                                                        |
| VUPRMRD         | Purchase request detail is empty.                                                                                                                                                   |
| VUPRMSD         | The supplierDetails field is missing from the request.                                                                                                                              |
| VUPRNSUEF       | When the user attempts to edit `ICMPUserEmail` in an ICMP-enabled purchase template, this error is returned.                                                                        |
| VUPRTNE         | The template id is not editable.                                                                                                                                                    |
| VUSR            | There was a problem Authenticating to the service.                                                                                                                                  |
| VVCGVC          | There was a problem getting the virtual card.                                                                                                                                       |
| VVCSVC          | There was a problem saving the virtual card.                                                                                                                                        |
| VVR             | There was a problem with the Responses. Please contact Technical Support.                                                                                                           |
| VVRS            | The purchase request status does not allow you to update.                                                                                                                           |
| VVRTC           | Purchase request type code is invalid.                                                                                                                                              |
| VP              | The PAN entered is invalid.                                                                                                                                                         |
| VCINFO          | Card information not found for the entered PAN.                                                                                                                                     |
| CCDCF           | Error while generating the Clearing Decisions report.                                                                                                                               |
| VFD             | Clearing Decisions report is not enabled by Mastercard.                                                                                                                             |
| VSD             | Clearing Decisions report is not enabled for the corporate.                                                                                                                         |
| VBLKPRAB        | Unable to block a previously blocked purchase request.                                                                                                                              |
| VBLKPRAU        | Unable to unblock a previously unblocked purchase request.                                                                                                                          |
| VBLKPRIV        | Unable to block or unblock the purchase request; invalid request id provided.                                                                                                       |
| VBLKPRIS        | Unable to block or unblock the purchase request; operation not permitted due to its current status: .                                                                               |
| VMTN            | Invalid maximum number of transactions. The Maximum number of transactions must not be negative.                                                                                    |
| VMTLE           | Invalid maximum number of transactions. The Maximum number of transactions must be less than 9 digits.                                                                              |

*** ** * ** ***

1. If Mastercard receives a 200 message (successful) that the customer does not receive, they can submit a *GET* to retrieve a message from the endpoint. [↩︎](https://developer.mastercard.com/iccp/documentation/error_handling/06error_codes/index.md#fnref:1)

   {#fn:1}
{#fn:1}
