Title Page
CyberSource Verification Services
Using the Simple Order API
October 2014
CyberSource Corporation HQ | P.O. Box 8999 | San Francisco, CA 94128-8999 | Phone: 800-530-9095
CyberSource Contact Information
For general information about our company, products, and services, go to
http://www.cybersource.com.
For sales questions about any CyberSource Service, email sales@cybersource.com or
call 650-432-7350 or 888-330-2300 (toll free in the United States).
For support information about any CyberSource Service, visit the Support Center at
http://www.cybersource.com/support.
Copyright
2014 CyberSource Corporation. All rights reserved. CyberSource Corporation ("CyberSource") furnishes this
document and the software described in this document under the applicable agreement between the reader of
this document ("You") and CyberSource ("Agreement"). You may use this document and/or software only in
accordance with the terms of the Agreement. Except as expressly set forth in the Agreement, the information
contained in this document is subject to change without notice and therefore should not be interpreted in any way
as a guarantee or warranty by CyberSource. CyberSource assumes no responsibility or liability for any errors
that may appear in this document. The copyrighted software that accompanies this document is licensed to You
for use only in strict accordance with the Agreement. You should read the Agreement carefully before using the
software. Except as permitted by the Agreement, You may not reproduce any part of this document, store this
document in a retrieval system, or transmit this document, in any form or by any means, electronic, mechanical,
recording, or otherwise, without the prior written consent of CyberSource.
Restricted Rights Legends
For Government or defense agencies. Use, duplication, or disclosure by the Government or defense agencies
is subject to restrictions as set forth the Rights in Technical Data and Computer Software clause at DFARS
252.227-7013 and in similar clauses in the FAR and NASA FAR Supplement.
For civilian agencies. Use, reproduction, or disclosure is subject to restrictions set forth in subparagraphs (a)
through (d) of the Commercial Computer Software Restricted Rights clause at 52.227-19 and the limitations set
forth in CyberSource Corporation's standard commercial agreement for this software. Unpublished rights
reserved under the copyright laws of the United States.
Trademarks
CyberSource, The Power of Payment, CyberSource Payment Manager, CyberSource Risk Manager,
CyberSource Decision Manager, CyberSource Connect, Authorize.Net, and eCheck.net are trademarks and/or
service marks of CyberSource Corporation. All other brands and product names are trademarks or registered
trademarks of their respective owners.
CONTENTS
Contents
Recent Revisions to This Document
About This Guide
Audience
Purpose
Scope
7
7
Conventions 8
Note and Important Statements 8
Text and Command Conventions 8
Related Documents
Customer Support
Chapter 1
9
9
Introducing Verification Services
10
Delivery Address Verification 10
Address Validation 11
Address Standardization 12
Countries Supported by Delivery Address Verification
Status and Error Codes 12
Export Compliance
Chapter 2
12
13
Integrating Verification Services into Your Business
Requesting Delivery Address Verification 14
Interpreting the Delivery Address Verification Reply
Returned Reply Fields 15
14
15
Requesting Export Compliance 17
Handling the Results of Denied Parties List Checks 17
Excluding Export Compliance Results 18
Configuring Denied Parties List Matches 19
Adjusting Name and Address Word Matching 20
Defining Name and Address Matching Rules 20
Verification Services Using the Simple Order API | October 2014
Contents
Chapter 3
Testing Verification Services
Requirements for Testing
Testing the Services
Appendix A API Fields
22
23
24
Formatting Restrictions
Data Type Definitions
Request Fields
Reply Fields
22
24
24
25
31
Appendix B Reason Codes
36
Appendix C Status and Error Codes
Status Codes: U.S. Addresses
39
40
Status Codes: International Addresses
Error Codes: U.S. Addresses
42
46
Error Codes: International Addresses
Appendix D Request and Reply Examples
47
49
Delivery Address Verification Examples
Name-Value Pair Request 49
Name-Value Pair Reply 50
XML Request 50
XML Reply 51
49
Export Compliance Examples 52
Name and Address Word Matching Examples 52
Name-Value Pair Request 53
Name-Value Pair Reply 53
XML Request 54
XML Reply 54
Name and Address Matching Rule Examples 55
Name-Value Pair Request 55
XML Request 56
Verification Services Using the Simple Order API | October 2014
Contents
Appendix E
Export Compliance Standard Codes
Denied Parties List Check Codes
Product Codes
Appendix F
57
57
59
Country and Territory Postal System Categories
Category I-A
60
Category I-B
61
Category II
61
Category III
62
Category IV
63
Appendix G Restricted and Denied Parties List
Appendix H Address Type
Index
60
69
71
72
Verification Services Using the Simple Order API | October 2014
REVISIONS
Recent Revisions to This
Document
Release
Changes
October 2014
Corrected the length of the API request field billTo_customerID.
Changed the number of characters from 50 to 100. See billTo_
customerID, page 25.
Corrected information about using addresses to trigger Denied Parties list
matches with the Export Service. Addresses cannot trigger these
matches on their own. Only customer names or company names can
trigger matches on their own. When used in combination with customer
names or company names, addresses can be used to eliminate false
positive matches. See "Export Compliance," page 13 and "Configuring
Denied Parties List Matches," page 19.
March 2014
Added the OFAC sublist, Foreign Sanctions Evaders, to the Restricted and
Denied Parties list. See Foreign Sanctions Evaders, page 70.
February 2014
Changed length of API reply fields of the String data type to 255 characters.
See "Reply Fields," page 31.
January 2014
This revision contains only editorial changes and no technical updates.
August 2013
Updated the description of the requestToken API reply field. See
requestToken, page 35.
Removed the requestToken API reply field from all code examples
because this value is no longer used. See "Request and Reply
Examples," page 49.
November 2012
Separated the CyberSource Verification Services Implementation Guide into
two documents:
CyberSource Verification Services Using the Simple Order API
CyberSource Verification Services Using the SCMP API
Verification Services Using the Simple Order API | October 2014
ABOUT GUIDE
About This Guide
Audience
This guide is written for application developers who want to use the CyberSource Simple
Order API to integrate address verification or U.S. export compliance verification services
into their order management system.
Implementing CyberSource Verification Services requires software development skills.
You must write code that uses the API request and reply fields to integrate Verification
Services into your existing order management system.
Purpose
This guide describes tasks you must complete to integrate Verification Services into your
existing order management system.
Scope
This guide describes only the tasks and API fields you must use to integrate Verification
Services into your order management system. It does not describe how to integrate other
CyberSource services. For that information, see "Related Documents," page 9.
Verification Services Using the Simple Order API | October 2014
About This Guide
Conventions
Note and Important Statements
A Note contains helpful suggestions or references to material not contained in
this document.
Note
An Important statement contains information essential to successfully
completing a task or learning a concept.
Important
Text and Command Conventions
Conventions
Usage
bold
Field and service names; for example:
Include the ics_applications field.
Items that you are instructed to act upon; for example:
Click Save.
italic
Filenames and pathnames. For example:
Add the filter definition and mapping to your web.xml file.
monospace
Placeholder variables for which you supply particular values.
XML elements.
Code examples and samples.
Text that you enter in an API environment; for example:
Set the davService_run field to true.
Verification Services Using the Simple Order API | October 2014
About This Guide
Related Documents
Getting Started with CyberSource Advanced for the Simple Order API describes how
to get started using the Simple Order API. (PDF | HTML)
Decision Manager Developer Guide Using the Simple Order API describes how to
integrate Decision Manager, a fraud detection service, with your order management
system. (PDF | HTML)
Credit Card Services Using the Simple Order API describes how to integrate
CyberSource payment processing services into your business. (PDF | HTML)
Reporting Developer's Guide describes how to view and configure Business Center
reports. (PDF | HTML)
Refer to the Support Center for complete CyberSource technical documentation:
http://www.cybersource.com/support_center/support_documentation
Customer Support
For support information about any CyberSource service, visit the Support Center at:
http://www.cybersource.com/support
Verification Services Using the Simple Order API | October 2014
CHAPTER
Introducing Verification
Services
CyberSource Verification Services are part of a suite of services that include electronic
payment and fraud management. Verification Services consist of two services:
Delivery Address Verification
Export Compliance
Note
You are responsible for creating your order acceptance strategy. If you do not
have the expertise, you are also responsible for seeking expert help outside of
your company. CyberSource cannot make recommendations for your
business.
Delivery Address Verification
Delivery Address Verification verifies a customers delivery address during card-notpresent transactions, and then it returns a result. The result contains an API-specific reply
code and a status or error code that is specific to the results of address verification.
Verification tests produce a valid address and an estimate of the risk associated with the
address. As a result, your shipping and customer service costs caused by address errors
can be reduced.
The verification process consists of validation and standardization of submitted
addresses. After a customer provides address information to your system, you send the
address in a request to CyberSource for verification.
When CyberSource Verification Services receives the address information in your
request, the address is validated and standardized as described in the following sections.
Verification Services Using the Simple Order API | October 2014
10
Chapter 1
Introducing Verification Services
Address Validation
During validation, address information is corrected. For example, the following items are
verified:
The street number must be valid for the street.
The street name must be valid for the city.
The postal code must be valid for the city.
If the postal code in the submitted address is valid, it is used to determine the city and
state or province.
Example 1
Customer Submitted Address Information
A customer submits the following address information to your system while placing an
order:
44 Fisher Street
Mtn View, Florida
94043
The address information submitted by the customer contains several errors that can be
corrected by Verification Services as described in the following table:
Table 1
Address Validation
Submitted Information
Problem
Corrected Address
44 Fisher Street
Street number is invalid.
34 Fisher Street
Mtn View
The first word of the city name
is abbreviated by using a nonstandard abbreviation, so it is
considered misspelled.
Mountain View
Mtn View, Florida 94043
The city and state do not
match the postal code.
Mountain View, California
94043
Verification Services Using the Simple Order API | October 2014
11
Chapter 1
Introducing Verification Services
Address Standardization
During standardization, address information is arranged in a consistent, preferred format
by using common abbreviations. For example:
DEPT is used for department
St for Street
SW for Southwest
After the address information submitted by the customer in Example 1 has been validated,
the address is standardized as follows:
Table 2
Address Standardization
Submitted Information
Problem
Corrected Address
34 Fisher Street
Mountain View, California
94043
The street and state names
should be abbreviated using
common abbreviations.
34 Fisher St
Mountain View, CA
94043
Countries Supported by Delivery Address
Verification
Delivery Address Verification uses data from postal service databases, which are
maintained by countries worldwide and are updated monthly. Over 200 countries and
territories provide information. These countries and territories are classified into
categories that are listed in Appendix F, "Country and Territory Postal System Categories,"
on page 60.
Status and Error Codes
CyberSource returns information codes for each address when address verification is
attempted. These codes can include an API-specific reply code and a status or error code
that describe the degree of match or reasons for the failure to match. When you have
integrated Verification Services into your business, your system interprets the reply codes
according to your business rules. Address verification failure rates depend on the address
location and the category of the country or territory as listed in Appendix F, "Country and
Territory Postal System Categories," on page 60. If an address requires correction, it is not
considered a failure.
Address verification can return one of the following results:
Address requires no correction. You receive the appropriate success information
code.
Address requires correction. You receive an API-specific reply code and a status code
that describes the type of correction that is applied.
Verification Services Using the Simple Order API | October 2014
12
Chapter 1
Introducing Verification Services
Address cannot be verified. You receive an API-specific failure code and an error code
that describes the type of failure.
For more information about API-specific reason codes, see "Reason Codes," page 36. For
more information about address verification status and error codes, see "Status and Error
Codes," page 39.
Export Compliance
Export Compliance enables you to comply with U.S. Export Administration Regulations,
which place restrictions on those with whom you can conduct business. The service
verifies customer information and returns detailed information about declined orders.
Export Compliance checks customer information by comparing it to many lists that are
maintained by government agencies to support export controls. If a customers first name
and last name or company name appears on any of the lists, you receive information
indicating that the transaction is declined. You also receive a description of how the names
match a list entry. For more information about restricted and denied parties lists, see
"Restricted and Denied Parties List," page 69.
You can use Export Compliance to manage your international sales territories by listing
the allowed and non-allowed export countries in each offer. A first name and last name or
company name can be matched more than once to a list when different spellings or
aliases exist. Although only some of these matches appear in the Business Center, all
matches appear in the API reply.
If you use Decision Manager, you can create custom rules based on information codes,
name matches, and export programs. In addition, you can create profile selector rules
based on a name and address match. For more information, see the Decision Manager
User Guide (PDF | HTML).
Verification Services Using the Simple Order API | October 2014
13
CHAPTER
Integrating Verification
Services into Your Business
For request and reply examples, see "Request and Reply Examples," page 49.
When requesting these services, be sure to send only valid and well-formed data in
all fields, especially in the credit card account number, billing address, email
address, and IP address fields.
CyberSource supports multi-byte characters for all services except Delivery
Address Verification, Stored Value, and Customer Profiles. Before implementing
any of these services, please contact your CyberSource representative to clarify
any questions you have about multi-byte character support.
Important
Requesting Delivery Address
Verification
To request the address verification service, set the davService_run field to true. When
requesting davService, do not request the following services:
Authorization Reversal (ccAuthReversalService). For more information about this
service, see Credit Card Services Using the Simple Order API (PDF | HTML).
Risk Update (riskUpdateService). For more information about this service, see
Decision Manager Developer Guide Using the Simple Order API (PDF | HTML).
To ignore the result of the address verification request so that the results do not prevent
other services from functioning, use the businessRules_ignoreDAVResult request field.
For descriptions of the request fields you can use, see "API Fields," page 24.
Verification Services Using the Simple Order API | October 2014
14
Chapter 2
Integrating Verification Services into Your Business
Interpreting the Delivery Address Verification
Reply
If Delivery Address Verification finds a match for the street address, it returns a corrected
and standardized address. If you have used the businessRules_ignoreDAVResult
request field, only a standardized address is returned. The standardized address is
divided into separate fields for the street address, city, state, province, territory, and postal
code. For descriptions of all the reply fields, see "API Fields," page 24. For examples, see
"Request and Reply Examples," page 49.
Returned Reply Fields
The reply contains the standardized address in the reply fields that begin with davReply_
standardized.
If you do not use the businessRules_ignoreDAVResult request field but want to know
whether the address is correct, use the davReply_reasonCode field to get the address
verification result.
Address verification is returned in the davReply_addressType field if the address can be
normalized. If the request contains both the shipping and billing addresses, the reply
contains information about the shipping address only. To obtain the most comprehensive
address verification information, CyberSource recommends that you send separate
requests for the billing address and the shipping address.
Status and Error Codes
For each verified address, you receive a status or an error code. Status codes contain
information about corrections or standardizations that are applied to the address. Error
codes contain information that explains why an address cannot be verified. Status and
error codes are returned in the following reply fields:
Table 3
Status and Error Code API Reply Fields
Status Codes
Error Codes
davReply_usInfo
davReply_usErrorInfo
davReply_caInfo
davReply_caErrorInfo
davReply_intlInfo
davReply_intlErrorInfo
For a complete list of the status and error codes that can be returned in reply fields, see
"Status and Error Codes," page 39.
Verification Services Using the Simple Order API | October 2014
15
Chapter 2
Example 2
Integrating Verification Services into Your Business
Status Code Example
Each digit in the status code means something. If you receive
davReply_usInfo=S80000 in the reply from CyberSource, each digit in the code is
interpreted as follows:
Table 4
Status Code Interpretation
Digit
Value
Interpretation
1st
Nothing truncated.
2nd
Assigned a different ZIP+4.
3rd
With primary name, directionals, and suffix, no significant difference between
input and corrected data.
4th
With country number, CART (carrier-route number), DPBC (delivery point
barcode), and unit designator, no significant difference between input and
corrected data.
5th
6th
No meaning is currently assigned to the 5th and 6th digits. They are reserved
for future use.
Example 3
Error Code Example
All error codes start with the letter E and contain a 3-digit number, which indicates one
specific type of error. You do not interpret each individual digit for error codes. For
example, if you receive davReply_usErrorInfo=E101 in the reply from CyberSource,
the city, state, or ZIP code are invalid or missing.
Note
For international addresses, you might receive a successful reply
(reasonCode=100) that contains an error code. You are responsible for
determining the level of risk for such an address match. Review these
addresses carefully before making a final decision on the order.
Information Codes
If you use the Advanced Fraud Screen scoring service in the same request, and the
normalized address appears to be risky, a RISK-AVS information code is returned. This
code means that the combined AVS (Address Verification Service) test result and the
normalized billing address are risky. For example, a risky address may be one in which the
AVS result indicates an exact match, but the normalized billing address is not deliverable.
All information codes are listed in the Information and Reply Codes appendix of the
Decision Manager Developer Guide Using the Simple Order API (PDF | HTML).
Verification Services Using the Simple Order API | October 2014
16
Chapter 2
Integrating Verification Services into Your Business
Requesting Export Compliance
To request Export Compliance, set the exportService_run field to true. For a list of the
fields to use when you request the service, see "Request Fields," page 25.
Do not request the following services at the same time that you request Export
Compliance:
Authorization Reversal (ccAuthReversalService). For more information about this
service, see Credit Card Services Using the Simple Order API (PDF | HTML).
Risk Update (riskUpdateService). For more information about this service, see the
Decision Manager Developer Guide Using the Simple Order API (PDF | HTML).
To list the allowed and not allowed countries for each offer, use the fields item_#_export
and item_#_noExport.
Export Compliance verifies the IP address in addition to verifying the country.
Note
Handling the Results of Denied Parties List
Checks
Countries with which U.S. trade is restricted are automatically checked during denied
parties checks. If a customers name or address strongly correlates with an entry in a
denied parties list (DPL), the following information is returned in the reply from
CyberSource:
Reason code 700
Because you always receive this flag for blocked countries, all customers from these
countries receive this reason code.
Reply fields starting with the deniedPartiesMatch_ prefix describe the denied parties
check correlation in more detail. You can receive an unlimited number of matches to
names, addresses, and programs within the lists.
Note
Example 4
The denied parties lists are watch lists that are maintained by U.S. government
entities, such as the U.S. Treasury Department or the U.S. Commerce
Department.
Denied Parties List Check Reply Example
The following example shows a reply in which the order data matched two denied parties
lists:
Verification Services Using the Simple Order API | October 2014
17
Chapter 2
Integrating Verification Services into Your Business
In the first list (Match_0), the order matched 3 sub lists: programs 1, 2, and 3.
In the second list (Match_1), the order matched 2 sub lists: programs 1 and 2.
deniedPartiesMatch_0_list=Bureau Of Industry and Security
deniedPartiesMatch_0_program_1=BXA_UNV
deniedPartiesMatch_0_program2=US_DEBARRED
deniedPartiesMatch_0_program_3=BXA_ENT
deniedPartiesMatch_1_list=Office of Foreign Assets Control
deniedPartiesMatch_1_program_1=SDNTK
deniedPartiesMatch_1_program_2=JADE
If you use Decision Manager, your custom rules that use Export match program as
the order element return all result values delimited with carets (^) in the
deniedPartiesMatch_N_program_N field. In the preceding example, the values are:
BXA_UNV^US_DEBARRED^BXA_ENT^SDNTK^JADE
The complete matched data is also available in the Case Details window.
Excluding Export Compliance Results
You can allow processing to continue regardless of the Export Compliance results by
using the businessRules_ignoreExportResult request field. If you use this field, be sure
to review all orders that fail Export Compliance.
When a transaction is declined by the DPL check or the export service, reason code 100
is returned for the transaction. In addition, the exportReply_infoCode field is returned,
containing one or more information codes. Other services in the request are processed
normally.
Note
If you use Decision Manager, you can create custom rules and profile selector
rules that use the information codes that you receive from Export Compliance.
These rules enable you to route different types of orders to specific review
queues in your order management system. If you subscribe to Enhanced Case
Management and want to view the export information results in the Case
Details window of the Business Center, you must use the businessRules_
ignoreExportResult field.
Verification Services Using the Simple Order API | October 2014
18
Chapter 2
Example 5
Integrating Verification Services into Your Business
Request and Reply Example that Uses the businessRules_
ignoreExportResult Field
The following request example shows the international data that is used by Export
Compliance and the use of the businessRules_ignoreExportResult field:
billTo_street1=26 JALAN MT. ERSKINE
billTo_city=PENANG
billTo_country=MY
billTo_hostname=www.cybersource.ir
exportService_run=true
businessRules_ignoreExportResult=true
shipTo_street1=26 JALAN MT. ERSKINE
shipTo_city=PENANG
shipTo_country=be
The following reply shows that Export Compliance was processed successfully
(reasonCode=100). However, three information codes were returned for the shipping
address, the host name, and the denied parties list check:
exportReply_infoCode=MATCH-SCO^MATCH-HCO^MATCH-DPC
exportReply_ipCountryConfidence=99
deniedPartiesMatch_0_address_0=26 JALAN MT. 1 ERSKINE,PENANG, MY,
deniedPartiesMatch_0_list=Bureau Of Industry and Security
decision=ACCEPT
reasonCode=100
exportReply_ReasonCode=100
Configuring Denied Parties List Matches
By default, Export Compliance searches for an exact match between a DPL and the
information in the request. However, you can adjust the parameters that control what is
required for a match by using the following order elements:
Name
Export Compliance requires at least the name of the customer or the company name.
Address
You can search by name and address. Provide as much information as possible to
reduce the number of false positives returned in the results.
A false positive result occurs when a DPL contains information that is common to several
individuals. For example, many people have the same first name, the same last name, or
even the same first and last name. However, it is unlikely that individuals have the same
first name, last name, company name, and address, especially if all of the information is
complete.
Verification Services Using the Simple Order API | October 2014
19
Chapter 2
Integrating Verification Services into Your Business
Adjusting Name and Address Word Matching
You can specify how closely a customers name, company name, or address must match
by using these optional request fields:
exportService_addressWeight
exportService_companyWeight
exportService_nameWeight
These fields can be set to exact, high, medium, or low to indicate how much the value
in the order can deviate from an entry in a DPL. For example, if you set exportService_
nameWeight to medium, and the customers name does not differ significantly from an
entry in a DPL, exportService detects a match. If you do not include these fields with your
request, Export Compliance searches for an exact match only. For usage examples of
these fields, see "Request and Reply Examples," page 49.
Defining Name and Address Matching Rules
Important
To accurately match customer and company names with entries on a DPL, you
must send names in the correct API field (billTo_firstName, billTo_lastName,
and billTo_company).
Use the exportService_addressOperator field to specify how Export Compliance
detects name and address matches. You can set this request field to one of the following
values:
AND (the default setting)
Important
Although this is the default setting for the exportService_
addressOperator field, you are responsible for ensuring that this setting
provides accurate and appropriate results for your business.
Export Compliance detects a match only if both the name and the address match an
entry in a DPL. Name can be the customers name or the company name. Export
Compliance evaluates all combinations available in the request:
Name and billing address
Name and shipping address
Company and billing address
Company and either shipping address, blocked billing, or blocked shipping
country
However, if a request contains only a name, the AND setting matches the name with
any address. Add all available address elements to receive the most accurate match
Verification Services Using the Simple Order API | October 2014
20
Chapter 2
Integrating Verification Services into Your Business
and the fewest false positives. For more information about the behavior of this setting,
see "Interactions between Match Weight and the AND Matching Rule."
OR
Export Compliance detects a match if the customers first name, last name, or
company name match an entry on a DPL. An address cannot trigger a DPL match on
its own.
IGNORE
Export Compliance detects a match based on only the customers name or the
company name and ignores the address. However, the blocked countries check is still
performed.
Interactions between Match Weight and the AND Matching Rule
When the exportService_addressOperator field is set to AND, a combination of
customer or company name and address is checked. All possible combinations are
evaluated before the DPL check results are returned. The match weight level specified for
the customer name or the company name (exportService_nameWeight and
exportService_companyWeight) is used for all order elements in the request.
Therefore, if you set name and company to different weights, and send a request that
contains a customer name, a company name, and an address, each pair of values is
evaluated independently.
Example 6
Export Compliance Evaluation Example
A request includes the following:
first and last name with the name weight set to high (exportService_
nameWeight=high)
company name with the company weight set to low (exportService_
companyWeight=low)
Export Compliance evaluates the request as follows:
A high weight is set on the combination of customer name and address. The customer
name and address cannot differ significantly from an entry in a DPL to register a
match.
A low weight is set on the combination of company name and address. The company
name and address can differ significantly from an entry in a DPL to register a match.
Verification Services Using the Simple Order API | October 2014
21
CHAPTER
Testing Verification Services
To ensure that your requests are processed correctly, you must test the basic success and
error conditions for each CyberSource service you plan to use.
Requirements for Testing
Before you can test, you must contact CyberSource Customer Support to
activate Verification Services and configure your account for testing.
Important
Use your regular CyberSource merchant ID when you are testing your system.
Unless otherwise specified, use test credit card numbers, not real ones. See Table 5,
page 23.
To test a successful transaction, use valid name and address information.
To test a declined transaction, use invalid information, such as an invalid address for
Delivery Address Verification or information with missing fields.
When testing the Simple Order API, use the following test URL:
https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor
If your system is configured correctly, you receive a reply with the expected reply fields
and reason codes. See "Reply Fields," page 31 and "Reason Codes," page 36.
If your tests are successful, contact your CyberSource representative to activate your
account so that you can send transactions to the CyberSource production server. To
process customer transactions, you must change the status of your account from test to
live production.
After you start processing transactions on the production server, you can configure
CyberSource reports. For more information, see the Reporting Developers Guide (PDF |
HTML).
Verification Services Using the Simple Order API | October 2014
22
Chapter 3
Testing Verification Services
Testing the Services
Use the credit card numbers in the following table to test the implementation of Verification
Services. Do not use real credit card numbers. To test card types not listed in the table,
use an account number that is within the cards BIN range. For best results, try each test
with a different CyberSource service request and with different test credit card numbers.
Remove spaces in test account numbers when sending them to CyberSource.
Note
Table 5
Test Credit Card Numbers
Credit Card Type
Test Account Number
American Express
3782
8224
6310
005
Discover
6011
1111
1111
1117
JCB
3566
1111
1111
1113
Laser
6304
9850
2809
0561
Maestro (International)
5033
9619
8909
17
5868
2416
0825
5333
6759
4111
0000
0008
6759
5600
4500
5727
5641
8211
1116
6669
MasterCard
5555
5555
5555
4444
UATP
1354
1234
5678
911
Visa
4111
1111
1111
1111
Maestro (UK Domestic)
Verification Services Using the Simple Order API | October 2014
515
38
054
23
APPENDIX
API Fields
Important
If you use Delivery Address Verification for non-U.S. requests, use version 1.31 or
later of the Simple Order API.
Download the API from the following URL:
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
Formatting Restrictions
Unless otherwise noted, all field names are case sensitive and all fields accept special
characters such as @, #, and %.
Important
The values of the item_#_ fields must not contain carets (^) or colons (:) because
these characters are reserved for use by CyberSource services.
The values of all request fields must not contain new lines or carriage returns.
However, they can contain embedded spaces and any other printable characters.
All leading and trailing spaces will be removed.
Data Type Definitions
For more information about these data types, see the World Wide Web Consortium (W3C)
XML Schema Part 2: Datatypes specification:
http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/
Data Type
Description
Integer
Whole number {, -3, -2, -1, 0, 1, 2, 3, }
String
Sequence of letters, numbers, spaces, and special characters, such as @ or #.
Verification Services Using the Simple Order API | October 2014
24
Appendix A
API Fields
Request Fields
See Getting Started with CyberSource Advanced for the Simple Order API (PDF | HTML)
for a description of how name-value pair names relate to their corresponding XML element
names.
Table 6
Request Fields
Field
Description
Used By:
Required (R)
or Optional (O)
Data Type
& Length
billTo_city
City of the billing address. If shipTo_city is
not provided, billTo_city is used in its place
for davService.
davService (R)
String (50)
Company name of person buying the
product.
exportService
(see description)
String (60)
Country of the billing address. Use the twocharacter country codes (see "Country and
Territory Postal System Categories,"
page 60). If shipTo_country is not provided,
billTo_country is used in its place for
davService.
davService (R)
String (2)
Customers account ID, tracking number,
reward number or other unique number that
you can assign to the customer.
davService (O)
billTo_email
Customers email address, including the full
domain name. The field must be submitted in
the form name@host.domain (for
example, jdoe@cybersource.com).
exportService (R)
String (255)
billTo_firstName
Customers first name.
exportService
(see description)
String (60)
billTo_company
exportService (R)
This field or billTo_firstName or billTo_
lastName must be present. Otherwise, your
request will fail.
billTo_country
billTo_customerID
Important This field or billTo_company or
exportService (R)
String (100)
exportService
(O)
billTo_lastName must be present.
Otherwise, your request will fail.
billTo_hostname
DNS resolved host name from billTo_
ipAddress.
exportService
(O)
String (40)
billTo_ipAddress
IP address of the customer (for example,
10.1.27.63).
exportService
(O)
String (15)
billTo_lastName
Customers last name.
exportService
(see description)
String (60)
Important At least this field or billTo_
company or billTo_firstName must be
present. Otherwise, your request will fail.
Verification Services Using the Simple Order API | October 2014
25
Appendix A
Table 6
API Fields
Request Fields (Continued)
Field
Description
Used By:
Required (R)
or Optional (O)
Data Type
& Length
billTo_postalCode
Postal code of the billing address. Make sure
that you send only valid and well-formed
data. Required only if the billTo_country
field is US or CA:
davService
(required for U.S.
and Canada)
String (10)
State or province of the billing address. Use
the two-character codes located in the
Support Center. If shipping the address
information is not provided, billTo_state is
used in place of shipTo_state for
davService.
davService (R)
String (2)
First line of the billing address.
davService (R)
US: numeric characters in either of these
formats:
billTo_state
billTo_street1
five characters: NNNNN
nine characters: NNNNN-NNNN
CA: six alphanumeric characters in this
format: ANA NAN
exportService
(required for U.S.
and Canada)
String (60)
exportService (R)
billTo_street2
Second line of the billing address.
davService (O)
String (60)
exportService
(O)
billTo_street3
to
billTo_Street4
Third and fourth line of the billing address.
davService (O)
String (60)
businessRules_
ignoreDAVResult
Used when requesting davService with
other services. Allows you to continue
processing the request even if davService
cannot verify the address. This field can
contain one of these values:
davService (O)
String (5)
true: Ignore the results of address
verification and continue to process the
request.
false: (default) If davService cannot
verify the address, stop processing the
request.
Verification Services Using the Simple Order API | October 2014
26
Appendix A
Table 6
API Fields
Request Fields (Continued)
Field
Description
Used By:
Required (R)
or Optional (O)
Data Type
& Length
businessRules_
ignoreExportResult
Used when requesting exportService with
other services or if the Denied Parties Check
(DPC) is enabled for your CyberSource
merchant ID. Allows you to continue
processing the request even if the order does
not pass Export Compliance. This field can
contain one of these values:
exportReply (O)
String (5)
Brief description of the order or any comment
that you wish to add to the order.
davService (O)
String (255)
Indicates whether to include davService in
your request. The field can contain one of
these values:
davService (O)
String (5)
exportService
(O)
String (3)
comments
davService_run
exportService_
addressOperator
true: Ignore the results of Export
Compliance and continue to process the
request. The reply will include information
about any DPC match.
false: (default) If the order does not
pass Export Compliance, stop processing
the request.
true: Include the service in your request.
false: (default) Do not include the
service in your request.
Parts of the customers information that must
match with an entry in the DPL before a
match occurs. This field can contain one of
these values:
exportReply (O)
AND: (default) The customers name or
company and the customers address
must appear in the database.
OR: The customers name must appear in
the database.
IGNORE: You want the service to detect a
match only of the customers name or
company but not of the address.
Verification Services Using the Simple Order API | October 2014
27
Appendix A
Table 6
API Fields
Request Fields (Continued)
Field
Description
Used By:
Required (R)
or Optional (O)
Data Type
& Length
exportService_addressWeight
Degree of correlation between a customers
address and an entry in the DPL before a
match occurs. This field can contain one of
these values:
exportService
(O)
String (6)
exportService
(O)
String (6)
exportService
(O)
String (6)
exact: The address must be identical to
the entry in the DPL.
high: (default) The address cannot differ
significantly from the entry in the DPL.
medium: The address can differ slightly
more from the entry in the DPL.
low: The address can differ significantly
from the entry in the DPL.
exportService_
companyWeight
Degree of correlation between a company
name and an entry in the DPL before a
match occurs. This field can contain one of
these values:
exact: The company name must be
identical to the entry in the DPL.
high: (default) The company name
cannot differ significantly from the entry in
the DPL.
medium: The company name can differ
slightly more from the entry in the DPL.
low: The company name can differ
significantly from the entry in the DPL.
exportService_nameWeight
Degree of correlation between a customers
name and an entry in the DPL before a
match occurs. This field can contain one of
these values:
exact: The name must be identical to
the entry in the DPL.
high: (default) The name cannot differ
significantly from the entry in the DPL.
medium: The name can differ slightly
more from the entry in the DPL.
low: The name can differ significantly the
entry in the DPL.
Verification Services Using the Simple Order API | October 2014
28
Appendix A
Table 6
API Fields
Request Fields (Continued)
Field
Description
Used By:
Required (R)
or Optional (O)
Data Type
& Length
exportService_run
Indicates whether to include exportService
in your request. The field can contain one of
these values:
exportService
(O)
String (5)
exportService
(O)
String (no
length limit)
exportService
(O)
String (no
length limit)
davService (O)
String (30)
item_#_export
true: Include the service in your request.
false: (default) Do not include the
service in your request.
List of ISO country codes for countries to
which the product can be exported. For more
information, see "Country and Territory
Postal System Categories," page 60.
Separate the codes by a single space, for
example: item_0_export=AF AL DZ
If the ISO country codes are not specified or
if this field is left blank, the U.S.
governments country code list is used.
Note The default list of countries restricted
by the U.S. always applies. Any country not
specifically added to the item_#_export field
is considered restricted.
item_#_noExport
List of ISO country codes for countries to
which the product cannot be exported. For
more information, see "Country and Territory
Postal System Categories," page 60.
Separate the codes by a single space, for
example, item_0_noExport=AF AL
DZ
Note If the item_#_export field is also
present, the content of item_#_noExport
overrides the content of item_#_export.
item_#_productCode
Type of product that the item contains, which
is also used to determine the category that
the product falls under (electronic, handling,
physical, service, or shipping).
exportService
(O)
Multiple productCode values can apply to
the same item (for example, shipping and
handling). The default value is default.
For more information, see "Product Codes,"
page 59.
item_#_productName
Name of the product.
davService (O)
String (30)
exportService
(O)
Verification Services Using the Simple Order API | October 2014
29
Appendix A
Table 6
API Fields
Request Fields (Continued)
Field
Description
Used By:
Required (R)
or Optional (O)
Data Type
& Length
item_#_productSKU
Products identifier code.
davService (O)
String (30)
exportService
(O)
item_#_quantity
Quantity of the product being purchased.
davService (O)
Integer (10)
exportService
(O)
Per-item price of the product. This value
cannot be negative. You can include a
decimal point (.) in this field, but you cannot
include any other special characters. The
amount is truncated at the request level to
the correct number of decimal places.
davService (R)
Your CyberSource merchant ID. Use the
same merchantID for evaluation, testing,
and production.
davService (R)
Merchant-generated order reference or
tracking number.
davService (R)
shipTo_city
City of the shipping address.
davService (R)
String (50)
shipTo_country
Country of the shipping address. Use the
two-character country codes (see "Country
and Territory Postal System Categories,"
page 60). For exportService, billTo_
country is used if shipTo_country is not
present.
davService (R)
String (2)
shipTo_firstName
First name of the person receiving the
shipment.
exportService
(O)
String (60)
shipTo_lastName
Last name of the person receiving the
shipment.
exportService
(O)
String (60)
shipTo_postalCode
Postal code of the shipping address.
Required if the value of shipTo_country is
CA or US.
davService (O)
String (10)
shipTo_state
State or province of the shipping address.
Use the two-character codes located in the
Support Center. The default value for
shipTo_state is billTo_state. Required if the
value of shipTo_country is CA or US.
davService (O)
String (2)
shipTo_street1
First line of the shipping address
davService (R)
String (60)
shipTo_street2
to
shipTo_street4
Second to fourth line of the shipping address.
davService (O)
String (60)
item_#_unitPrice
merchantID
merchantReferenceCode
Verification Services Using the Simple Order API | October 2014
String (15)
exportService (R)
String (30)
exportService (R)
String (50)
exportService (R)
exportService
(O)
30
Appendix A
API Fields
Reply Fields
Table 7
Reply Fields
Field
Description
Returned By
Data Type
& Length
davReply_addressType
Contains the record type of the postal code
with which the address was matched.
davReply
String (255)
U.S. Addresses
Depending on the quantity and quality of the
address information provided, this field
contains one or two characters:
One character: sufficient correct information
was provided to result in accurate matching.
Two characters: standardization would
provide a better address if more or better
input address information were available.
The second character is D (default).
Blank fields are unassigned. When an
address cannot be standardized, how the
input data was parsed determines the
address type. In this case, standardization
may indicate a street, rural route, highway
contract, general delivery, or PO box.For
possible values, see Appendix H, "Address
Type," on page 71.
All other countries
This field contains one of these values:
P: Post.
S: Street.
x: Unknown.
davReply_barCode
Delivery point bar code determined from the
input address.
davReply
String (255)
davReply_barCodeCheckDigit
Verification digit for the 11-digit delivery point
bar code.
davReply
Integer (1)
davReply_caErrorInfo
4-character error code returned for Canadian
addresses. For possible values, see "Error
Codes: International Addresses," page 47.
davReply
String (255)
davReply_caInfo
4- to 10-character status code returned for
Canadian addresses. For possible values,
see "Status Codes: International Addresses,"
page 42.
davReply
String (255)
davReply_careOf
Care of data dropped from the standard
address.
davReply
String (255)
Verification Services Using the Simple Order API | October 2014
31
Appendix A
Table 7
API Fields
Reply Fields (Continued)
Field
Description
Returned By
Data Type
& Length
davReply_countryErrorInfo
4-character error code returned for
international addresses. For possible values,
see "Error Codes: International Addresses,"
page 47.
davReply
String (255)
davReply_intlErrorInfo
4-character error code returned for
international addresses. For possible values,
see "Error Codes: International Addresses,"
page 47.
davReply
String (255)
davReply_intlInfo
4- to 10-character status code returned for
international addresses. For possible values,
see "Status Codes: International Addresses,"
page 42.
davReply
String (255)
davReply_matchScore
Indicates the probable correctness of the
address match. Returned for U.S. and
Canadian addresses. Returns a value from
0-9, where 0 is most likely to be correct and
9 is least likely to be correct, or -1 if there is
no address match.
davReply
Integer (1)
davReply_reasonCode
A numeric value corresponding to the result
of the Delivery Address Verification request.
For a list of possible values, see "Reason
Codes," page 36.
davReply
Integer (5)
davReply_
standardizedAddress1
First line of the standardized address,
including apartment information.
davReply
String (255)
davReply_
standardizedAddress2
to
davReply_
standardizedAddress4
Second to fourth line of the standardized
address.
davReply
String (255)
davReply_standardizedAddress
NoApt
First line of the standardized address,
without apartment information. Returned for
U.S. and Canadian addresses.
davReply
String (255)
davReply_standardizedCity
Standardized city name.
davReply
String (255)
davReply_standardizedCountry
Standardized country name.
davReply
String (255)
davReply_standardizedCounty
Standardized county name.
davReply
String (255)
davReply_standardizedCSP
Standardized city, state or province, and
ZIP+4 code or postal code line.
davReply
String (255)
davReply_
standardizedISOCountry
Standardized two-character ISO country
code.
davReply
String (255)
davReply_
standardizedPostalCode
Standardized U.S. ZIP+4 code or postal
code.
davReply
String (255)
davReply_standardizedState
U.S. Postal Service standardized state or
province abbreviation.
davReply
String (255)
Verification Services Using the Simple Order API | October 2014
32
Appendix A
Table 7
API Fields
Reply Fields (Continued)
Field
Description
Returned By
Data Type
& Length
davReply_usErrorInfo
4-character error code returned for U.S.
addresses; for possible values, see "Error
Codes: U.S. Addresses," page 46.
davReply
String (255)
davReply_usInfo
4- to 10-character status code returned for
U.S. addresses; for possible values, see
"Status Codes: U.S. Addresses," page 40.
davReply
String (255)
decision
Summarizes the result of the overall request.
The field can contain one of these values:
davReply
String (255)
ACCEPT
ERROR
REJECT
exportReply
deniedPartiesMatch_N_
address_0
to
deniedPartiesMatch_N_
address_N
Address found on the list specified in
deniedPartiesMatch_N_list for the entity
(name and address) in the request.
exportReply
String (255)
deniedPartiesMatch_N_list
List on which the first DPC correlation
appears. For a list of codes, see "Denied
Parties List Check Codes," page 57.
exportReply
String (255)
deniedPartiesMatch_N_name_
0
to
deniedPartiesMatch_N_name_
N
Name found in the list specified in
deniedPartiesMatch_N_list for the entity
(name and address) in the request.
exportReply
String (255)
deniedPartiesMatch_N_
program_N
Sub-lists matched by the order data. List
members are separated by carets (^).
exportReply
String (255)
Verification Services Using the Simple Order API | October 2014
33
Appendix A
Table 7
API Fields
Reply Fields (Continued)
Field
Description
Returned By
Data Type
& Length
exportReply_infoCode
Returned when the Denied Parties list check
(first two codes) or the export service (all
others) would have declined the transaction.
This field can contain one or more of these
values:
exportReply
String (255)
MATCH-DPC: Denied Parties List match.
UNV-DPC: Denied Partied List
unavailable.
MATCH-BCO: Billing country restricted.
MATCH-EMCO: Email country restricted.
MATCH-HCO: Host name country
restricted.
MATCH-IPCO: IP country restricted.
MATCH-SCO: Shipping country restricted.
Multiple information codes are separated by
a caret (^). For more information, see
"Excluding Export Compliance Results,"
page 18.
exportReply_
ipCountryConfidence
Likelihood that the country associated with
the customers IP address was identified
correctly. Returns a value from 1100; 100
indicates the highest likelihood. If the country
cannot be determined, the value is 1.
exportReply
Integer (3)
exportReply_reasonCode
Numeric value corresponding to the result of
the Export Compliance service request. For
possible values, see "Reason Codes,"
page 36.
exportReply
Integer (5)
invalidField_0
to
invalidField_N
Fields in the request that contained invalid
data.
davReply
String (255)
merchantReferenceCode
Merchant-generated order tracking number.
davReply
exportReply
String (255)
exportReply
missingField_0
to
missingField_N
Required fields that are missing from the
request.
davReply
reasonCode
Numeric value corresponding to the result of
the overall request. For possible values, see
"Reason Codes," page 36.
davReply
Identifier for the request.
davReply
requestID
String (255)
exportReply
Integer (5)
exportReply
String (255)
exportReply
Verification Services Using the Simple Order API | October 2014
34
Appendix A
Table 7
API Fields
Reply Fields (Continued)
Field
Description
Returned By
Data Type
& Length
requestToken
Request identifier generated by
CyberSource.
davReply
String (256)
exportReply
Request token data created by CyberSource
for each reply. The field is an encoded string
that contains no confidential information
such as an account or card verification
number. The string can contain a maximum
of 256 characters.
Verification Services Using the Simple Order API | October 2014
35
APPENDIX
Reason Codes
The following table describes the reason codes returned by the Simple Order API for
Verification Services. For a description of replies, decisions, and reason codes, see the
information about handling replies in Getting Started with CyberSource Advanced for the
Simple Order API (PDF | HTML).
Because CyberSource can add reply fields and reason codes at any time, your
error handler must:
Important
Table 8
Parse the reply data according to the names of the fields instead of their order in the
reply. For more information about parsing reply fields, see the documentation for
your client.
Use the decision fields to obtain the result if it receives a reason code that it does
not recognize.
Reason Codes
Reason Code
Description
Returned By
100
Successful transaction.
davReply
exportReply
101
102
150
151
The request is missing one or more required fields.
davReply
Possible action: See the reply fields missingField_0 to missingField_N
for the missing fields. Resend the request with the complete information.
exportReply
One or more fields in the request contains invalid data.
davReply
Possible action: See the reply fields invalidField_0 to invalidField_N for
the invalid fields. Resend the request with the correct information.
exportReply
Error: General system failure.
davReply
Possible action: Wait a few minutes and resend the request.
exportReply
Error: The request was received but the server timed out. This error does
not include time-outs between the client and the server.
davReply
exportReply
Possible action: Wait a few minutes and resend the request.
152
234
Error: The request was received but the service timed out.
davReply
Possible action: Wait a few minutes and resend the request.
exportReply
A problem exists with your CyberSource merchant configuration.
davReply
Possible action: Do not resend the request. Contact Customer Support to
correct the configuration problem.
exportReply
Verification Services Using the Simple Order API | October 2014
36
Appendix B
Table 8
Reason Codes
Reason Codes
Reason Code
Description
Returned By
450
The apartment number missing or not found.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
451
The request contains insufficient the address information.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
452
The house number or post office box identifier cannot be found on the
specified street.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
453
Multiple address matches were found. This code is returned only for U.S.
addresses.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
454
The post office box identifier cannot be found or is out of range.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
455
The route service identifier cannot be found or is out of range.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
456
The street name cannot be found in the specified postal code.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
457
The postal code cannot be found.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
458
The address cannot be verified or corrected.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
459
Multiple address matches were found; returned for only non-U.S.
addresses.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
460
An address match cannot be found; No reason can be given.
davReply
Possible action: Ask the customer to verify the address information and
resend the request.
461
The character set is not supported by the address verification service.
davReply
Possible action: Verify the character set that you are using to process
transactions.
Verification Services Using the Simple Order API | October 2014
37
Appendix B
Table 8
Reason Codes
Reason Codes
Reason Code
Description
Returned By
700
The customer is on a list issued by the U.S. government containing entities
with whom trade is restricted.
exportReply
Possible action: Reject the customers order.
701
One or both of these events occurred:
The U.S. government maintains an embargo against the country
indicated in the billing or shipping address.
You supplied an export list for one or more of the offers in the order, but
the shipping country submitted by the customer is not in that list.
exportReply
Possible action: Reject the customers order.
702
The U.S. government maintains an embargo against the country
associated with the email address.
exportReply
Possible action: Reject the customers order.
703
The U.S. government maintains an embargo against the country
associated with the IP address.
exportReply
Possible action: Reject the customers order.
Verification Services Using the Simple Order API | October 2014
38
APPENDIX
Status and Error Codes
This appendix describes the status and error codes that are returned in API reply fields for
U.S. and international addresses. Status codes contain information about corrections or
standardizations that are applied to an address. Error codes contain information that
explains why an address cannot be verified. Status and error codes are returned in the
following reply fields:
Table 9
Status and Error Codes API Reply Fields
Status Codes
Error Codes
davReply_usInfo
davReply_usErrorInfo
davReply_caInfo
davReply_caErrorInfo
davReply_intlInfo
davReply_intlErrorInfo
Verification Services Using the Simple Order API | October 2014
39
Appendix C
Status and Error Codes
Status Codes: U.S. Addresses
Table 10
Status Codes Returned for U.S. Addresses
Ordinal Digit
Value
Description
Address line is truncated to make it fit into the field.
Both the address line and the city name are truncated.
City name is truncated to make it fit into the field.
Nothing is truncated.
No significant difference between input and corrected data for city,
state, ZIP, and ZIP+4.
Corrected the ZIP.
Corrected the city.
Corrected the city and ZIP.
Corrected the state.
Corrected the state and ZIP.
Corrected the city and state.
Corrected the city, state, and ZIP.
Corrected the ZIP+4.
Corrected the ZIP and ZIP+4.
Corrected the city and ZIP+4.
Corrected the city, ZIP, and ZIP+4.
Corrected the state and ZIP+4.
Corrected the state, ZIP, and ZIP+4.
Corrected the city, state, and ZIP+4.
Corrected the city, state, ZIP, and ZIP+4.
1st
2nd
Verification Services Using the Simple Order API | October 2014
40
Appendix C
Table 10
Status Codes Returned for U.S. Addresses (Continued)
Ordinal Digit
3rd
Status and Error Codes
Value
Description
No significant difference between input and corrected data for
primary street name, directional prefix (predirectional), directional
suffix (postdirectional), and street-type suffix.
Corrected the street-type suffix.
Corrected the predirectional.
Corrected the predirectional and street-type suffix.
Corrected the postdirectional.
Corrected the street-type suffix and postdirectional.
Corrected the predirectional and postdirectional.
Corrected the predirectional, street-type suffix, and postdirectional.
Corrected the primary street name.
Corrected the primary street name and street-type suffix.
Corrected the predirectional and primary street name.
Corrected the predirectional, primary street name, and street-type
suffix.
Corrected the primary street name and postdirectional.
Corrected the primary street name, street-type suffix, and
postdirectional.
Corrected the predirectional, primary street name, and
postdirectional.
Corrected the predirectional, primary street name, postdirectional,
and street-type suffix.
Verification Services Using the Simple Order API | October 2014
41
Appendix C
Table 10
Status and Error Codes
Status Codes Returned for U.S. Addresses (Continued)
Ordinal Digit
4th
Value
Description
No significant difference between input and corrected data for
county number, CART (carrier-route number), DPBC (delivery point
barcode), and unit designator.
Corrected the unit designator.
Corrected the DPBC.
Corrected the DPBC and unit designator.
Corrected the CART.
Corrected the CART and unit designator.
Corrected the CART and DPBC.
Corrected the CART, DPBC, and unit designator.
Corrected the county number.
Corrected the county number and unit designator.
Corrected the county number and DPBC.
Corrected the county number, DPBC, and unit designator.
Corrected the county number and CART.
Corrected the county number, CART, and unit designator.
Corrected the county number, CART, DPBC.
Corrected the county number, CART, DPBC, and unit designator.
5th
Reserved for future use.
6th
Reserved for future use.
Status Codes: International
Addresses
Table 11
Status Codes Returned for International Addresses
Ordinal Digit
1st
Value
Description
Status
Verification Services Using the Simple Order API | October 2014
42
Appendix C
Table 11
Status Codes Returned for International Addresses (Continued)
Ordinal Digit
2nd
Status and Error Codes
Value
Description
No significant difference between input and corrected data for
country, postal code, region, and locality.
Corrected the country.
Corrected the postal code.
Corrected the country and postal code.
Corrected the region.
Corrected the country and region.
Corrected the postal code and region.
Corrected the country, postal code, and region.
Corrected the locality.
Corrected the country and locality.
Corrected the postal code and locality.
Corrected the country, postal code, and locality.
Corrected the region and locality.
Corrected the country, region, and locality.
Corrected the postal code, region, and locality.
Corrected the country, postal code, region, and locality.
Verification Services Using the Simple Order API | October 2014
43
Appendix C
Table 11
Status and Error Codes
Status Codes Returned for International Addresses (Continued)
Ordinal Digit
Value
Description
No significant difference between input and corrected data for
directional prefix (predirectional), directional suffix (postdirectional),
primary street type, primary street name, and primary range.
Corrected the predirectional and postdirectional.
Corrected the street type.
Corrected the predirectional, postdirectional, and primary street
type.
Corrected the primary street name.
Corrected the predirectional, postdirectional, and primary street
name.
Corrected the primary street type and primary street name.
Corrected the predirectional, postdirectional, primary street type,
and primary street name.
Corrected the primary range.
Corrected the predirectional, postdirectional, and primary range.
Corrected the primary street type and primary range.
Corrected the predirectional, postdirectional, primary street type,
and primary range.
Corrected the primary street name and primary range.
Corrected the predirectional, postdirectional, primary street name,
and primary range.
Corrected the primary street type, primary street name, and primary
range.
Corrected the predirectional, postdirectional, primary street type,
primary street name, and primary range.
3rd
Verification Services Using the Simple Order API | October 2014
44
Appendix C
Table 11
Status Codes Returned for International Addresses (Continued)
Ordinal Digit
4th
5th
6th
Status and Error Codes
Value
Description
No significant difference between input and corrected data for unit
description, unit number, building name, and firm name.
Corrected the unit description.
Corrected the unit number.
Corrected the unit description and unit number.
Corrected the building name.
Corrected the unit description and building name.
Corrected the unit number and building name.
Corrected the unit description, unit number, and building name.
Corrected the firm.
Corrected the unit description and firm.
Corrected the unit number and firm.
Corrected the unit description, unit number, and firm.
Corrected the building name and firm.
Corrected the unit description, building name, and firm.
Corrected the unit number, building name, and firm.
Corrected the unit description, unit number, building name, and firm.
No significant difference between input and corrected data for other
components that are not considered basic address components.
Corrected other primary address components.
Corrected other secondary address components.
Corrected other primary and secondary address components.
Europe, Middle East, and Africa (EMEA) engine: archived record
used for assignment.
Global address engine (New Zealand): base record assignment.
Global address engine (New Zealand): record ignored.
Global address engine (Brazil): Large Volume Receiver (LVR).
Global Address Cleanse (New Zealand): Unique address.
Verification Services Using the Simple Order API | October 2014
45
Appendix C
Status and Error Codes
Error Codes: U.S. Addresses
Table 12
Error Codes Returned for U.S. Addresses
Code
Description
E101
City, state, or ZIP code is incorrect or missing.
E212
No city and incorrect ZIP code.
E213
Incorrect city, valid state or province, and no ZIP code.
E214
Incorrect city and ZIP code.
E216
Incorrect ZIP code. Cannot determine city.
E302
No primary address line parsed.
E412
Street name not found in directory.
E413
Possible street-name matches too closely to select one.
E420
Primary range is missing.
E421
Primary range is invalid for the street, route, or building.
E422
Predirectional is needed. Input is wrong or missing.
E423
Street-type suffix is needed. Input is wrong or missing.
E425
Street-type suffix, predirectional, or postdirectional is needed. Input is wrong or
missing.
E427
Postdirectional is needed. Input is wrong or missing.
E428
Incorrect ZIP code. Cannot match address.
E429
Incorrect city. Cannot match address.
E430
Possible address-line matches too closely to select one.
E431
Urbanization needed. Input is wrong or missing.
E439
Exact match made in EWS (Early Warning System) directory of the USPS.
E500
Other error.
E501
Foreign address.
E502
Input record blank.
E503
ZIP code is not in the area covered by the partial ZIP+4 directory.
E504
Overlapping ranges in the ZIP+4 directory.
E505
Address is not in the USPS directories. Undeliverable address.
E600
Marked by the USPS as unsuitable for mail delivery.
E601
Primary address number not in DPV (Delivery Point Validation) database of the USPS,
and ZIP+4 was removed.
Verification Services Using the Simple Order API | October 2014
46
Appendix C
Status and Error Codes
Error Codes: International
Addresses
Table 13
Code
Error Codes Returned for International Addresses
Description
Input Record Discrepancies
1020
Address validated in multiple countries.
1030
Country code invalid or absent from the request.
1040
At least one address character not in supported character set.
1060
Country is not supported.
Inconsistent Last Line Information
2000
Unable to identify the locality, state, or postal code.
2010
Unable to identify the locality. Invalid postal code.
2020
Unable to identify the postal code. Invalid locality that prevents possible address
correction.
2030
Invalid locality and postal code that prevents possible address correction.
2040
Invalid postal code that prevents locality selection.
2050
Last line matches too closely to select one. Last line of address, which depends on the
countrys address format, is incorrect. For example, in the U.S., last lines of an address
should contain city, state, and postal code.
Inconsistent Address Information
3000
Unable to identify the primary address line. Valid locality, region, and postal code.
3010
Unable to match primary name to the directory. Valid locality, region, and postal code.
3020
Possible primary name matches too closely to select one.
3030
Valid primary street name but missing range.
3040
Valid primary street name but invalid range.
3050
Invalid or missing primary street type that prevents a possible address match.
3060
Missing primary street type and directional information that prevents possible address
match.
3070
Invalid or missing directional information that prevents possible address match.
3080
Invalid or missing postal code that prevents possible address match.
3090
Invalid locality that prevents possible address match.
3100
Possible address line matches too closely to select one.
3110
Address conflicts with postal code. The same primary street name has a different postal
code.
Address with Low Likelihood of Delivery
4000
Invalid or missing secondary address that prevents a possible secondary address line
match. Locality, region, postal code, and primary address are valid.
Verification Services Using the Simple Order API | October 2014
47
Appendix C
Table 13
Status and Error Codes
Error Codes Returned for International Addresses (Continued)
Code
Description
4010
Possible secondary address matches too closely to select one.
All Other Types of Information
5000
Valid address, but address is classified undeliverable by a postal authority.
5010
Address is not in specified country.
5020
Blank input record.
6000
Unclassified error.
Verification Services Using the Simple Order API | October 2014
48
APPENDIX
Request and Reply
Examples
Delivery Address Verification
Examples
The service requested is davService.
Name-Value Pair Request
davService_run=true
merchantID=example
merchantReferenceCode=482046C3A7E94F5
billTo_street1=1295 charleston boulevard
billTo_city=Mtn view
billTo_state=ca
billTo_postalCode=94043
billTo_country=us
Verification Services Using the Simple Order API | October 2014
49
Appendix D
Request and Reply Examples
Name-Value Pair Reply
The following example shows a reply that uses the name-value pair. Depending on the
results, some of the fields may be returned empty. Note the status code of S80000
returned by davReply_usInfo.
requestID=0183045530000167905080
merchantReferenceCode=482046C3A7E94F5
decision=ACCEPT
reasonCode=100
davReply_reasonCode=100
davReply_addressType=S
davReply_barCode=130795
davReply_barCodeCheckDigit=5
davReply_careOf=
davReply_matchScore=2
davReply_standardizedAddress1=1295 Charleston Rd
davReply_standardizedAddress2=
davReply_standardizedAddressNoApt=1295 Charleston Rd
davReply_standardizedCity=Mountain View
davReply_standardizedCSP=Mountain View CA 94043-1307
davReply_standardizedState=CA
davReply_standardizedPostalCode=94043-1307
davReply_standardizedCounty=Santa Clara
davReply_standardizedCountry=US
davReply_standardizedISOCountry=US
davReply_usInfo=S80000
XML Request
Important
The following XML examples contain an API version number. Do not use that
version number because it may not be the most current. To find the most
current version of the API, see https://ics2ws.ic3.com/commerce/1.x/
transactionProcessor.
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data1.23">
<merchantID>example</merchantID>
<merchantReferenceCode>482046C3A7E94F5</merchantReferenceCode>
<billTo>
<street1>1295 charleston boulevard</street1>
<city>Mtn view</city>
<state>ca</state>
<postalCode>94043</postalCode>
<country>us</country>
</billTo>
<davService run="true"/>
</requestMessage>
Verification Services Using the Simple Order API | October 2014
50
Appendix D
Request and Reply Examples
XML Reply
Depending on the results, some of the elements may be returned empty.
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data1.23">
<c:requestID>0183045530000167905080</c:requestID>
<c:merchantReferenceCode>482046C3A7E94F5</c:merchantReferenceCode>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:davReply>
<c:reasonCode>100</c:reasonCode>
<c:addressType>S</c:addressType>
<c:apartmentInfo/>
<c:barCode>130795</c:barCode>
<c:barCodeCheckDigit>5</c:barCodeCheckDigit>
<c:careOf/>
<c:cityInfo>C</c:cityInfo>
<c:directionalInfo/>
<c:matchScore>2</c:matchScore>
<c:standardizedAddress1>1295 Charleston Rd
</c:standardizedAddress1>
<c:standardizedAddress2/>
<c:standardizedAddressNoApt>1295 Charleston Rd
</c:standardizedAddressNoApt>
<c:standardizedCity>Mountain View</c:standardizedCity>
<c:standardizedCounty>Santa Clara</c:standardizedCounty>
<c:standardizedCSP>Mountain View CA 94043-1307
</c:standardizedCSP>
<c:standardizedState>CA</c:standardizedState>
<c:standardizedPostalCode>94043-1307</c:standardizedPostalCode>
<c:standardizedCountry>US</c:standardizedCountry>
<c:standardizedISOCountry>US</c:standardizedISOCountry>
<c:stateInfo/>
<c:suffixInfo>S</c:suffixInfo>
<c:usInfo>S80000</c:usInfo>
<c:overallInfo/>
</c:davReply>
</c:replyMessage>
Verification Services Using the Simple Order API | October 2014
51
Appendix D
Request and Reply Examples
Export Compliance Examples
Name and Address Word Matching Examples
The following request examples specify that for a match to occur:
The address must be very near an entry on a DPL (denied parties list).
In the name-value pair example, exportService_addressWeight is set to high. In
the XML example, <addressWeight> is set to high.
The customer name or company name can differ slightly more.
In the name-value pair example, exportService_nameWeight and exportService_
companyWeight are set to medium. In the XML example, <nameWeight> and
<companyWeight> are set to medium.
For more information about adjusting how names and addresses are matched with DPLs,
see "Adjusting Name and Address Word Matching," page 20.
Verification Services Using the Simple Order API | October 2014
52
Appendix D
Request and Reply Examples
Name-Value Pair Request
exportService_run=true
merchantID=example
merchantReferenceCode=482046C3A7E94F5
billTo_firstName=John
billTo_lastName=Doe
billTo_street1=1295 Charleston Rd.
billTo_city=Mountain View
billTo_state=CA
billTo_postalCode=94043
billTo_country=US
billTo_phoneNumber=650-965-6000
billTo_email=jdoe@example.com
billTo_ipAddress=127.0.0.1
item_0_unitPrice=20.00
item_0_noExport=AF AL DZ
exportService_addressWeight=high
exportService_companyWeight=medium
exportService_nameWeight=medium
Name-Value Pair Reply
requestID=0305782650000167905080
merchantReferenceCode=482046C3A7E94F5
decision=ACCEPT
reasonCode=100
exportReply_ReasonCode=100
exportReply_ipCountryConfidence=98
Verification Services Using the Simple Order API | October 2014
53
Appendix D
Request and Reply Examples
XML Request
Important
The following XML examples contain an API version number. Do not use that
version number because it may not be the most current. To find the most
current version of the API, see https://ics2ws.ic3.com/commerce/1.x/
transactionProcessor.
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data1.23">
<merchantID>example</merchantID>
<merchantReferenceCode>482046C3A7E94F5</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Doe</lastName>
<street1>1295 Charleston Rd.</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
<phoneNumber>650-965-6000</phoneNumber>
<email>jdoe@example.com</email>
<ipAddress>127.0.0.1</ipAddress>
</billTo>
<item id="0">
<unitPrice>20.00</unitPrice>
<noExport>AF AL DZ</noExport>
</item>
<exportService run="true">
<addressWeight>high</addressWeight>
<companyWeight>medium</companyWeight>
<nameWeight>medium</nameWeight>
</exportService>
</requestMessage>
XML Reply
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data1.23">
<c:requestID>0305782650000167905080</c:requestID>
<c:merchantReferenceCode>482046C3A7E94F5</c:merchantReferenceCode>
<c:decision>ACCEPT</c:decision>
<c:reasonCode>100</c:reasonCode>
<c:exportReply>
<c:reasonCode>100</c:reasonCode>
<c:ipCountryConfidence>98</c:ipCountryConfidence>
</c:exportReply>
</c:replyMessage>
Verification Services Using the Simple Order API | October 2014
54
Appendix D
Request and Reply Examples
Name and Address Matching Rule Examples
The following request examples specify that for a match to occur, the DPL must include
the customers name or the company name and the address by using the following fields:
exportService_addressOperator=AND (name-value pair)
<addressOperator>AND</addressOperator> (XML)
For more information about adjusting the rules for matching names and addresses with
DPLs, see "Defining Name and Address Matching Rules," page 20.
Name-Value Pair Request
exportService_run=true
merchantID=example
merchantReferenceCode=482046C3A7E94F5
billTo_firstName=John
billTo_lastName=Doe
billTo_street1=1295 Charleston Rd.
billTo_city=Mountain View
billTo_state=CA
billTo_postalCode=94043
billTo_country=US
billTo_phoneNumber=650-965-6000
billTo_email=jdoe@example.com
billTo_ipAddress=127.0.0.1
item_0_unitPrice=20.00
item_0_noExport=AF AL DZ
exportService_addressOperator=AND
Verification Services Using the Simple Order API | October 2014
55
Appendix D
Request and Reply Examples
XML Request
Important
The following XML examples contain an API version number. Do not use that
version number because it may not be the most current. To find the most
current version of the API, see https://ics2ws.ic3.com/commerce/1.x/
transactionProcessor.
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data1.22">
<merchantID>example</merchantID>
<merchantReferenceCode>482046C3A7E94F5</merchantReferenceCode>
<billTo>
<firstName>John</firstName>
<lastName>Doe</lastName>
<street1>1295 Charleston Rd.</street1>
<city>Mountain View</city>
<state>CA</state>
<postalCode>94043</postalCode>
<country>US</country>
<phoneNumber>650-965-6000</phoneNumber>
<email>jdoe@example.com</email>
<ipAddress>127.0.0.1</ipAddress>
</billTo>
<item id="0">
<unitPrice>20.00</unitPrice>
<noExport>AF AL DZ</noExport>
</item>
<exportService run="true">
<addressOperator>AND</addressOperator>
</exportService>
</requestMessage>
Verification Services Using the Simple Order API | October 2014
56
APPENDIX
Export Compliance
Standard Codes
Export Compliance returns the following codes.
Denied Parties List Check Codes
The following table contains result codes that are returned for denied parties list (DPL)
checks. Each code represents one of the denied parties lists that are checked by Export
Compliance. These codes are returned in the deniedPartiesMatch_#_list reply field.
When these codes are returned, Export Compliance has detected a match between order
data and an entry in the denied parties list represented by the code.
Table 14
Denied Parties List Check Codes
Code
Description
GOV-US-DBR
Debarred Parties List
GOV-US-DPL
Denied Party List, Bureau of Export Administration
GOV-US-ENT
Entity List, Bureau of Export Administration
GOV-US-SDN-BAKN
Balkans List - Specially Designated Nationals List
GOV-US-SDN-BPI-PA
Blocked Pending Investigation - Patriot Act, Specially
Designated Nationals List
GOV-US-SDN-CU
Cuba List - Specially Designated Nationals List
GOV-US-SDN-FTO
Foreign Terrorist Organization, Specially Designated Global
Terrorist - Specially Designated Nationals List
GOV-US-SDN-IQ
Iraq List - Specially Designated Nationals List
GOV-US-SDN-IR
Iran List - Specially Designated Nationals List
GOV-US-SDN-KP
North Korea List - Specially Designated Nationals List
GOV-US-SDN-LY
Libya List - Specially Designated Nationals List
GOV-US-SDN-SD
Sudan List - Specially Designated Nationals List
GOV-US-SDN-SDFT
Specially Designated Terrorist, Foreign Terrorist Organization,
Terrorism List Government Sanctions - Specially Designated
Nationals List
Verification Services Using the Simple Order API | October 2014
57
Appendix E
Export Compliance Standard Codes
Table 14
Denied Parties List Check Codes (Continued)
Code
Description
GOV-US-SDN-SDGT
Specially Designated Global Terrorist - Specially Designated
Nationals List
GOV-US-SDN-SDNT
Specially Designated Narcotic Trafficker - Specially Designated
Nationals List
GOV-US-SDN-SDNTK
Specially Designated Narcotic Trafficker (Kingpin Act) - Specially
Designated Nationals List
GOV-US-SDN-SDT
Specially Designated Terrorist - Specially Designated Nationals
List
GOV-US-SDN-SDTG
Specially Designated Terrorist, Terrorism List Government
Sanctions Regulations - Specially Designated Nationals List
GOV-US-SDN-TABN
Taliban List - Specially Designated Nationals List
GOV-US-SDN-UNITA
National Union for the Total Independence of Angola & The
Armed Forces for the Liberation of Angola - Specially Designated
Nationals List
GOV-US-SDN-YU
Federal Republic of Yugoslavia (Milosevic) - Specially
Designated Nationals List
GOV-US-SPS-EMB
Embargo List - U.S. Dept. of Commerce, Bureau of Export
Administration and Office of Foreign Assets
Verification Services Using the Simple Order API | October 2014
58
Appendix E
Export Compliance Standard Codes
Product Codes
The following table lists the values that you can use with the item_#_product_code
request field.
Table 15
Product Codes
Code
Description
adult_content
Adult content.
coupon
Coupon applied to the entire order.
default
Default value for the product code. CyberSource uses
default when a request provides no value for the product
code.
electronic_good
Electronic product other than software.
electronic_software
Software distributed electronically rather than on tapes, disks,
or other media.
gift_certificate
Gift certificate not issued with CyberSource Stored Value
Services.
handling_only
Separate charge that is generally a fee imposed by the seller
on the customer. The fee pays for the sellers administrative
selling costs.
service
Service that you perform for the customer.
shipping_and_handling
Shipping is a separate charge for shipping the product to the
purchaser. Handling is generally a fee imposed by the seller
to pay for administrative selling costs.
shipping_only
Charge for transporting tangible personal property from the
seller to the purchaser. Documentation must be maintained
that clearly establishes where title to the tangible personal
property passed from the seller to the purchaser.
stored_value
Stored Value certificate.
subscription
Subscription to a web site or other content.
Verification Services Using the Simple Order API | October 2014
59
APPENDIX
Country and Territory Postal
System Categories
This appendix groups countries and territories according to the similarity of their postal
systems. Delivery Address Verification uses the databases maintained by these postal
systems to verify order address information.
Important
This note applies to categories II, III, and IV. If Delivery Address Verification
cannot verify an address completely, or if the address cannot be matched with
a postal database entry, you do not receive a successful reply. If the address is
listed in a postal database, the service validates the accuracy of the address
provided by the customer. When evaluating the reply of the service, make sure
that you consider the error and status codes that also may be present in the
reply. See "Status and Error Codes," page 39.
Category I-A
These countries have rigorous testing and a postal certification process that results in the
largest amount and greatest accuracy of postal data.
Table 16
Category I-A Country and Territory Postal Systems
Country
Code
Australia
AU
Canada
CA
United States
US
Includes:
American Samoa [AS]
Federated States of Micronesia [FM]
Guam [GU]
Marshall Islands [MH]
Northern Mariana Islands [MP]
Palau [PW]
Puerto Rico [PR]
Virgin Islands [VI]
Verification Services Using the Simple Order API | October 2014
60
Appendix F
Country and Territory Postal System Categories
Category I-B
These countries provide complete address data, including all street names and all valid
address ranges for the buildings on the streets. Although the postal systems of these
countries lack the rigor of the Category I-A postal systems, these countries generally
provide reasonably accurate and almost complete postal information.
Table 17
Category I-B Country and Territory Postal Systems
Country
Code
Netherlands
NL
United Kingdom
GB
Includes:
Ireland [IE]
Category II
These countries have fairly reliable postal systems and provide street names, city names,
and postal codes for large and small cities. However, they provide incomplete ranges for
the addresses of buildings. Therefore, you can often trust the validation results for the
street name, city name, and postal code, but you cannot trust the validation of building
addresses.
Table 18
Category II Country and Territory Postal Systems
Country
Code
Denmark
DK
Includes:
Faroe Islands [FO]
France
FR
Includes:
French Guiana [GF]
Guadeloupe [GP]
Martinique [MQ]
Reunion [RE]
Mayotte [YT]
Monaco [MC]
Saint Pierre and Miquelon [PM]
French Polynesia [PF]
New Caledonia [NC]
Wallis and Futuna [WF]
Germany
Verification Services Using the Simple Order API | October 2014
DE
61
Appendix F
Table 18
Country and Territory Postal System Categories
Category II Country and Territory Postal Systems (Continued)
Country
Code
Switzerland
CH
Includes:
Liechtenstein [LI]
Category III
The postal systems in these countries provide street names, city names, and postal codes
for large cities only and incomplete or no information for smaller cities. These postal
systems may also provide an extremely limited set of building address ranges. Therefore,
you can trust the validation results for city name, street name, and postal code for larger
cities. For smaller cities, you can trust validation results for city name and postal code.
Table 19
Category III Country and Territory Postal Systems
Country
Code
Austria
AT
Belgium
BE
Finland
FI
Italy
IT
Includes:
Vatican City [VA]
San Marino [SM]
Luxembourg
LU
New Zealand
NZ
Norway
NO
Poland
PL
Portugal
PT
South Africa
ZA
Spain
ES
Sweden
SE
Verification Services Using the Simple Order API | October 2014
62
Appendix F
Country and Territory Postal System Categories
Category IV
In these countries, the postal systems are highly variable. Most countries provide a list of
cities and postal codes. However, all cities and postal codes might not be present in the
countrys postal database.
Table 20
Category IV Country and Territory Postal Systems
Country
Code
Afghanistan
AF
Albania
AL
Algeria
DZ
Andorra
AD
Angola
AO
Anguilla (UK)
AI
Antigua and Barbuda
AG
Argentina
AR
Armenia
AM
Aruba
AW
Azerbaijan
AZ
Bahamas
BS
Bahrain
BH
Bangladesh
BD
Barbados
BB
Belarus
BY
Belize
BZ
Benin
BJ
Bermuda (UK)
BM
Bhutan
BT
Bolivia
BO
Bosnia and Herzegovina
BA
Botswana
BW
Brazil
BR
British Virgin Islands (UK)
VG
Brunei
BN
Bulgaria
BG
Burkina Faso
BF
Burundi
BI
Cambodia
KH
Verification Services Using the Simple Order API | October 2014
63
Appendix F
Table 20
Country and Territory Postal System Categories
Category IV Country and Territory Postal Systems (Continued)
Country
Code
Cameroon
CM
Cape Verde
CV
Cayman Islands (UK)
KY
Central African Republic
CF
Chad
TD
Chile
CL
China
CN
Includes:
Macau [MO]
Christmas Island (AU)
CX
Cocos (Keeling) Islands (AU)
CC
Columbia
CO
Comoros
KM
Congo, Democratic Republic of the
CD
Congo
CG
Cook Islands (NZ)
CK
Costa Rica
CR
Cte dIvoire
CI
Croatia
HR
Cuba
CU
Cyprus
CY
Czech Republic
CZ
Djibouti
DJ
Dominica
DM
Dominican Republic
DO
Ecuador
EC
Egypt
EG
El Salvador
SV
Equatorial Guinea
GQ
Eritrea
ER
Estonia
EE
Ethiopia
ET
Falkland Islands (UK)
FK
Fiji
FJ
Gabon
GA
Verification Services Using the Simple Order API | October 2014
64
Appendix F
Table 20
Country and Territory Postal System Categories
Category IV Country and Territory Postal Systems (Continued)
Country
Code
Gambia
GM
Georgia
GE
Ghana
GH
Gibraltar (UK)
GI
Greece
GR
Greenland (DK)
GL
Grenada
GD
Guatemala
GT
Guinea
GN
Guinea-Bissau
GW
Guyana
GY
Haiti
HT
Honduras
HN
Hong Kong
HK
Hungary
HU
Iceland
IS
India
IN
Indonesia
ID
Iran
IQ
Iraq
IE
Israel
IL
Jamaica
JM
Japan
JP
Jordan
JO
Kazakhstan
KZ
Kenya
KE
Kiribati
KI
Korea, Democratic Peoples Republic (North)
KP
Korea, Republic of (South)
KR
Kosovo
KV
Kuwait
KW
Kyrgyzstan
KG
Laos
LA
Latvia
LV
Lebanon
LB
Verification Services Using the Simple Order API | October 2014
65
Appendix F
Table 20
Country and Territory Postal System Categories
Category IV Country and Territory Postal Systems (Continued)
Country
Code
Lesotho
LS
Liberia
LR
Lithuania
LT
Libya
LY
Macedonia
MK
Madagascar
MG
Malawi
MW
Malaysia
MY
Maldives
MV
Mali
ML
Malta
MT
Mauritania
MR
Mauritius
MU
Mexico
MX
Moldova
MD
Mongolia
MN
Montenegro
ME
Montserrat (UK)
MS
Morocco
MA
Mozambique
MZ
Myanmar
MM
Namibia
NA
Nauru
NR
Nepal
NP
Netherlands Antilles (NL)
AN
Nicaragua
NI
Niger
NE
Nigeria
NG
Niue
NU
Norfolk Island (AU)
NF
Oman
OM
Pakistan
PK
Panama
PA
Papua New Guinea
PG
Paraguay
PY
Verification Services Using the Simple Order API | October 2014
66
Appendix F
Table 20
Country and Territory Postal System Categories
Category IV Country and Territory Postal Systems (Continued)
Country
Code
Peru
PE
Philippines
PH
Pitcairn Islands (UK)
PN
Qatar
QA
Romania
RO
Russia
RU
Rwanda
RW
Saint Helena (UK)
SH
Saint Kitts and Nevis
KN
Saint Lucia
LC
Saint Vincent and the Grenadines
VC
Samoa
WS
Sao Tome and Principe
ST
Saudi Arabia
SA
Senegal
SN
Serbia
RS
Seychelles
SC
Sierra Leone
SL
Singapore
SG
Slovakia
SK
Slovenia
SI
Solomon Islands
SB
Somalia
SO
South Georgia and the South Sandwich Islands (UK)
GS
Sri Lanka
LK
Sudan
SD
Suriname
SR
Swaziland
SZ
Syria
SY
Taiwan
TW
Tajikistan
TJ
Tanzania
TZ
Thailand
TH
Timor-Leste
TL
Togo
TG
Verification Services Using the Simple Order API | October 2014
67
Appendix F
Table 20
Country and Territory Postal System Categories
Category IV Country and Territory Postal Systems (Continued)
Country
Code
Tokelau
TK
Tonga
TO
Trinidad and Tobago
TT
Tunisia
TN
Turkey
TR
Turkmenistan
TM
Turks and Caicos Islands (UK)
TC
Tuvalu
TV
Uganda
UG
Ukraine
UA
United Arab Emirates
AE
Uruguay
UY
Uzbekistan
UZ
Vanuatu
VU
Venezuela
VE
Vietnam
VN
Western Sahara
EH
Yemen
YE
Zambia
ZM
Zimbabwe
ZW
Verification Services Using the Simple Order API | October 2014
68
APPENDIX
Restricted and Denied
Parties List
Export Compliance uses the following government agency lists to screen order data. If you
use Decision Manager, you can use these lists to create custom rules.
The BXA/BIS list has been replaced by the BIS, DOC_DTC, and DOC_ISN
lists.
Important
Table 21
Restricted and Denied Parties List
List
Program Abbreviation
Name
BIS
BIS_DPL
BIS Denied Person List
BIS_UNV
BIS Unverified List
BIS_ENT
BIS Entity List
DOS_
DTC
US_DEBARRED
Defense Trade Controls Debarred Parties List
DOS_
ISN
ISN_ISNA
Iran Syria Non-Proliferation Act of 2005
ISN_MSL
BIS Missile Sanctions Laws
ISN_CBW
BIS Chemical and Biological Weapons Sanctions
ISN_NPWMD
Nonproliferator Weapons of Mass Destruction
ISN_LME
Sanctions for the Transfer of Lethal Military
Equipment
ISN_Iran_Iraq
Iran-Iraq Arms Nonproliferation Act of 1992
ISN_INKSNA
Iran, North Korea, Syria Nonproliferation Act
Sanctions
ISN_INPA
Iran Nonproliferation act of 2000
US_DEBARRED
DTC - Debarred Parties
BALKANS
Balkans
BELARUS
Belarus Executive Order and Designations
BPI-PA
Blocked Pending Investigation - Patriot Act of 2001
BPI-SDNT
Blocked Pending Investigation - SDNT
OFAC
Verification Services Using the Simple Order API | October 2014
69
Appendix G
Table 21
List
Restricted and Denied Parties List
Restricted and Denied Parties List (Continued)
Program Abbreviation
Name
BPI-SDNTK
Blocked Pending Investigation - SDNT kingpin Act
BURMA
Burma
JADE
Burma Juntas Anti-Democratic Efforts
COTED
Cte d'Ivoire
CUBA
Cuba Sanctions
DRCONGO
Democratic Republic of the Congo
FinCEN 311 list:
FINCEN_311R
The Final Rule
FINCEN_311P
The Notice of Proposed Rulemaking
FSE-IR
Foreign Sanctions Evaders
FTO
Foreign Terrorist Organization
IRAN
Iran
Iraq Sanctions:
IRAQ2
Blocking property of the former regimes Exec 13315
Executive Order 13350
IRAQ3
TEL
LEBANON
Lebanon
LIBERIA
Liberia
NPWMD
Non-Proliferators Weapons of Mass Destruction
NS-PLC
Non-SDN Palestinian Legislative Council
NKOREA
North Korea
SDGT
Specially Designated Global Terrorist
SDNT
Specially Designated Narcotics Traffickers
SDNTK
Specially Designated Narcotics Traffickers Kingpin Act
SDT
Specially Designated Terrorist
SUDAN
Sudan
DARFUR
Sudan Darfur Region
SYRIA
Syria
WMD
Weapons of Mass Destruction Trade Control
Regulations
ZIMB
Zimbabwe
DOS_TEL
Terrorist Exclusion List
Verification Services Using the Simple Order API | October 2014
70
APPENDIX
Address Type
The following address type codes are returned in the davReply_addressType reply field.
Table 22
Address Type Codes
Code
Description
Firm.
General delivery.
High-rise apartment or office building.
Military.
Post office box.
Rural route or highway contract.
Street (usually one side of one city block).
FD
Firm default. The standardization process was unable to assign a firm extended ZIP
code.
GD
General delivery default. Assign when general delivery is the only primary name listed
for the ZIP code.
HD
High-rise default. The standardization process assigned the extended ZIP code for the
entire building. Assignment at the unit, floor, or wing level is possible. A suite or
apartment number may be out of range.
RD
Rural route or highway contract default. The standardization process assigned the
extended ZIP code for the entire route but was unable to assign the box number.
SD
Street default. The standardization process assigned the extended ZIP code for the
block because no extended ZIP code for the building.
UD
Unique default. Either the owner of the ZIP code did not assign extended ZIP codes, or
the address was not matched.
Verification Services Using the Simple Order API | October 2014
71
INDEX
Index
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
conflicting services 14
how verification works 11
ignoring result 14
multi-byte character support 14
results returned 12, 15
A
activating Verification Services 22
address
standardization example 12
validation example 11
AND name and address matching rule 20
Authorization Reversal service conflicts
with Delivery Address Verification 14
with Export Compliance 17
denied parties list checks
definition 17
example 17
results in Case Details window 18
return reason code 700 17
with Decision Manager 18
deniedPartiesMatch reply fields 17
businessRules_ignoreDAVResult 14
Enhanced Case Management, viewing export
information 18
businessRules_ignoreExportResult example 19
C
card-not-present transactions 10
Case Details window contains denied parties list
check results 18
credit card number for testing 23
D
Decision Manager
Case Details window contains denied parties
list check results 18
Export match program order element 18
used with denied parties list checks 18
used with Export Compliance 13
default name and address matching rule 20
Delivery Address Verification
Verification Services Using the Simple Order API | October 2014
error codes
API reply fields returned in 15
definition 15
example 16
examples
address standardization 12
address validation 11
denied parties list checks 17
error codes 16
Export Compliance AND matching rule 21
request that uses businessRules_
ignoreExportResult 19
risky address 16
status codes 16
Export Compliance
AND matching rule example 21
AND name and address matching rule 20
conflicting services 17
72
Index
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
custom rules information codes 18
default name and address matching rule 20
IGNORE name and address matching
rule 21
IP address checks 17
OR name and address matching rule 21
profile selector rules information codes 18
results displayed in Business Center 13
used with Decision Manager 13, 18
I
IGNORE name and address matching rule 21
information codes
returned with Advanced Fraud Screen
scoring service 16
RISK-AVS 16
with Delivery Address Verification 14
with Export Compliance 17
RISK-AVS information code 16
risky address example 16
S
special characters accepted by API 24
status codes
API reply fields returned in 15
definition 15
example 16
T
test credit card numbers 23
testing URL 22
IP address checks in Export Compliance 17
M
matching rule
AND 20
IGNORE 21
OR 21
multi-byte character support 14
U
U.S. Export Administration Regulations 13
URL for test transactions 22
V
Verification Services activation 22
N
name and address matching rule
AND 20
IGNORE 21
OR 21
O
OR name and address matching rule 21
R
reason code 700 returned for denied parties list
checks 17
reply fields starting with deniedPartiesMatch 17
Risk Update service conflicts
Verification Services Using the Simple Order API | October 2014
73