Viewing the Status of Your Batch File Submissions
Before processing the requests in your batch file, the Offline Transaction File Submission service validates the batch file. After attempting to validate your batch file, Cybersource creates the following types of XML-formatted response files that indicate whether the validation succeeded or failed:
nSuccessful validation file—this file indicates that your batch file is valid.
Filename format:
<merchantID>.<batchID>.validate.Success.xml
Example file name:
CyberVacations.39762.validate.Success.xml
nFailed validation file—this file indicates that your batch file is invalid and provides information about why the file failed validation.
File name format:
<merchantID>.<batchID>.validate.xml
Example file name:
CyberVacations.39768.validate.xml
The response files are available in the Reports area on the Business Center. For transactions in India, go to https://ebc2.in.cybersource.com/ebc2/. You can download them the same way that you download Cybersource reports, which is explained in the Business Center Reporting User Guide (PDF | HTML).
These validation files are an optional feature. Contact Customer Support to have your account configured for these files.
The <Batch> element is the root of the response file.
|
<Batch BatchID=CDATA MerchantID=CDATA Name=CDATA Version=NMTOKEN> (ValidationStatus) (ValidatedRecords) (ValidationTime) (ValidationErrors) </Batch> |
|
Attribute Name |
Description |
Data Type & Length |
|
BatchID |
Batch file identifier that you assigned. |
Alphanumeric (8) |
|
MerchantID |
Your Cybersource merchant ID. |
Alphanumeric (30) |
|
Name |
Name of the report. This value is always OLP Validation Report. |
Alphanumeric (25) |
|
Version |
Version number of the report. The current version number is 1.0. |
Numeric (10) |
|
Element Name |
Description |
Data Type & Length |
|
ValidationStatus |
Status of the attempted validation. Possible values: nFailed nSuccess nOnHold nToBeResolved |
Alphanumeric (10) |
|
ValidatedRecords |
Number of records validated. This value is present only when the validation is successful. |
Numeric (10) |
|
ValidationTime |
Timestamp for the validation process. Format: yyyy-MM-ddTHH:mm:ss |
DateTime (25) |
|
ValidationErrors |
List of the errors in the batch file. This element is present only if the validation failed. See <ValidationErrors>. |
Element |
The <ValidationErrors> element contains the errors associated with the batch file.
|
<ValidationErrors> (Error)* </ValidationErrors> |
|
Element Name |
Description |
Data Type & Length |
|
Error |
Information about an error. See <Error>. |
Element |
The <Error> element contains information about an error.
|
<Error> (RecordNumber) (ErrorCode) (ErrorMessage) (ErrorRemedy) </Error> |
|
Element Name |
Description |
Data Type & Length |
|
RecordNumber |
Number of the record that has an error. |
Numeric (10) |
|
ErrorCode |
Code that identifies the error. See Error Codes. |
Numeric (10) |
|
ErrorMessage |
Message that describes the error. |
Alphanumeric (250) |
|
ErrorRemedy |
Message that describes the remedy for the error. |
Alphanumeric (250) |
These error codes, messages, and remedies are included in the <Error> element. In the following table, the %s in the error messages will be replaced with dynamic values, such as batch IDs and record numbers, in the actual error messages.
|
Error Code |
Error Message |
Remedy |
|
101 |
Missing required field in File Header record: %s. |
Include the required field in the file and try again. |
|
102 |
MerchantID (%s) is not in our database. |
Ensure that the merchant ID is valid. |
|
103 |
MerchantID (%s) does not match with the ID used to log in for uploading the file. |
Verify the merchantID and try again. |
|
104 |
batchID exceeds max length of %s. |
Generate a shorter batch ID and try again. |
|
105 |
%s had already passed validation stage. |
The batch ID has previously been submitted. If this is a new batch, generate a new batch ID and send the file again. |
|
106 |
Invalid recordCount value: %s. |
Check record count to make sure it is numeric and try again. |
|
107 |
The file does not contain any data records. |
The file must contain at least one data record. Correct and try again. |
|
108 |
The recordCount exceeds the maximum number of records allowed per batch (%s). |
Generate a smaller batch file and try again. |
|
109 |
Invalid creationDate format: %s. |
Correct the date format and try again (use yyyy-mm-dd). |
|
110 |
Unsupported service: %s. |
The service is not supported through batching. You may only request that service directly online. |
|
111 |
Missing required field in Data Header record: %s. |
Include the missing required field in the file and try again. |
|
112 |
Missing required field in Data Record: %s. |
Include the required field in the file and try again. |
|
113 |
merchantID %s is not valid or has not been configured correctly. |
Contact Cybersource to confirm that the merchant ID you are using is valid or is configured to be submitted by another merchant ID. |
|
114 |
SUM in Trailer record (%s) does not match with actual total (%s). |
Make sure the sum in the Trailer record matches with the actual sum of all data records. |
|
115 |
SUM in Trailer record is invalid (%s). |
Check to make sure the sum value is numeric. |
|
116 |
Missing required field in File Trailer record: %s. |
Pass in required field and try again. |
|
117 |
Duplicate file (batchID: %s). |
Make sure that the batch ID is unique. |
|
118 |
Duplicate file. The data content in this file seems to have been submitted in batchID=%s. |
Make sure the content of the file has not been previously submitted. |
|
119 |
File Trailer record is missing. |
Correct file format and try again. |
|
120 |
There was a problem reading the input file. |
Contact Cybersource to verify that file %s was received and is readable. |
|
121 |
Found Data Header record but missing File Header record. |
Correct file format and try again. |
|
122 |
Found Data record but missing Data Header record. |
Correct file format and try again. |
|
123 |
Number of fields (%s) does not match with number of field names (%s). |
Correct file format and try again. |
|
124 |
Found trailer record but missing File/Data Header record. |
Correct file format and try again. |
|
201 |
There was a problem inserting the batch status in the database. |
Contact Cybersource. |
|
202 |
Problem updating: batchID: %s, status: %s" |
Contact Cybersource. |
|
203 |
There was a problem retrieving the merchant configuration from the database. |
Contact Cybersource. |
|
204 |
There was a problem validating the batchID against the database. |
Contact Cybersource. |
|
205 |
There was a database problem while doing the checksum. |
Contact Cybersource. |
|
301 |
There was an internal error while validating the file. |
Contact Cybersource. |
|
<!ELEMENT Batch (ValidationStatus, ValidatedRecords, ValidationTime, ValidationErrors)> <!ATTLIST Batch BatchID CDATA #REQUIRED MerchantID CDATA #REQUIRED Name CDATA #REQUIRED Version NMTOKEN #REQUIRED> <!ELEMENT ValidationStatus (#PCDATA)> <!ELEMENT ValidatedRecords (#PCDATA)> <!ELEMENT ValidationTime (#PCDATA)> <!ELEMENT ValidationErrors (Error)*> <!ELEMENT Error (RecordNumber, ErrorCode, ErrorMessage, ErrorRemedy)> <!ELEMENT RecordNumber (#PCDATA)> <!ELEMENT ErrorCode (#PCDATA)> <!ELEMENT ErrorMessage (#PCDATA)> <!ELEMENT ErrorRemedy (#PCDATA)> |
Example Success
|
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE Batch SYSTEM "olp_validation_report_1_0.dtd"> <Batch BatchID="11111" MerchantID="gpntest" Name="OLP Validation Report" Version="1.0"> <ValidationStatus>Success</ValidationStatus> <ValidatedRecords>15</ValidatedRecords> <ValidationTime>2009-07-31T14:41:12</ValidationTime> </Batch> |
Example Failure Scenario 1
|
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE Batch SYSTEM "olp_validation_report_1_0.dtd"> <Batch BatchID="22222" MerchantID="gpntest" Name="OLP Validation Report" Version="1.0"> <ValidationStatus>Failed</ValidationStatus> <ValidationTime>2009-07-31T14:40:14</ValidationTime> <ValidationErrors> <Error> <RecordNumber>3</RecordNumber> <ErrorCode>123</ErrorCode> <ErrorMesssage>Number of fields (17) does not match with <ErrorRemedy>Correct file format and try again. </Error> </ValidationErrors> </Batch> |
Example Failure Scenario 2
|
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE Batch SYSTEM "olp_validation_report_1_0.dtd"> <Batch BatchID="33333" MerchantID="gpntest" Name="OLP Validation Report" Version="1.0"> <ValidationStatus>Failed</ValidationStatus> <ValidationTime>2009-07-31T14:40:36</ValidationTime> <ValidationErrors> <Error> <RecordNumber>0</RecordNumber> <ErrorCode>114</ErrorCode> <ErrorMessage>SUM in Trailer record (14.00) does not match <ErrorRemedy>Make sure the SUM in the Trailer record matches </Error> </ValidationErrors> </Batch> |