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)

exportService (R)

String (50)

billTo_company

Company name of person buying the product.

Important  This field or billTo_firstName and billTo_lastName must be present. Otherwise, your request will fail.

exportService (see description)

String (60)

billTo_country

Country of the billing address. Use the two-character country or region codes (see Country or Region and Territory Postal System Categories). If shipTo_country is not provided, billTo_country is used in its place for davService.

davService (R)

exportService (R)

String (2)

billTo_customerID

Customer’s account ID, tracking number, reward number, or other unique number that you can assign to the customer.

davService (O)

exportService (O)

String (100)

billTo_email

Customer’s 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

Customer’s first name.

Important  If you submit this field, you must also submit billTo_lastName. Alternatively, you can submit billTo_company field instead of billTo_firstName and billTo_lastName. Otherwise, your request will fail.

exportService (see description)

String (60)

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

Customer’s last name.

Important  If you submit this field, you must also submit billTo_firstName. Alternatively, you can submit billTo_company field instead of billTo_firstName and billTo_lastName. Otherwise, your request will fail.

exportService (see description)

String (60)

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:

nUS: numeric characters in either of these formats:

lfive characters: NNNNN

lnine characters: NNNNN-NNNN

nCA: six alphanumeric characters in this format: ANA NAN

davService (required for U.S. and Canada)

String (10)

billTo_state

State or province of the billing address. Use the two-character codes located in the Support Center. If the shipping address information is not provided, billTo_state is used in place of shipTo_state for davService.

Required if the value of billTo_country is CA or US.

davService (O)

exportService (O)

String (2)

billTo_street1

First line of the billing address.

davService (R)

exportService (R)

String (60)

billTo_street2

Second line of the billing address.

davService (O)

exportService (O)

String (60)

billTo_street3
   to
billTo_Street4

Third and fourth line of the billing address.

davService (O)

String (60)

businessRules_ignoreDAVResult

Use 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:

ntrue: Ignore the results of address verification and continue to process the request.

nfalse: (default) If davService cannot verify the address, stop processing the request.

davService (O)

String (5)

businessRules_ignoreExportResult

Use 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:

ntrue: Ignore the results of Export Compliance and continue to process the request. The reply will include information about any DPC match.

nfalse: (default) If the order does not pass Export Compliance, stop processing the request.

exportReply (O)

String (5)

comments

Brief description of the order or any comment that you wish to add to the order.

davService (O)

exportReply (O)

String (255)

davService_run

Indicates whether to include davService in your request. The field can contain one of these values:

ntrue: Include the service in your request.

nfalse: (default) Do not include the service in your request.

davService (O)

String (5)

exportService_addressOperator

Parts of the customer’s information that must match with an entry in the DPL before a match occurs. This field can contain one of these values:

nAND: (default) The customer’s name or company and the customer’s address must appear in the database.

nOR: The customer’s name must appear in the database.

nIGNORE: You want the service to detect a match only of the customer’s name or company but not of the address.

exportService (O)

String (3)

exportService_addressWeight

Degree of correlation between a customer’s address and an entry in the DPL before a match occurs. This field can contain one of these values:

nexact: The address must be identical to the entry in the DPL.

nhigh: (default) The address cannot differ significantly from the entry in the DPL.

nmedium: The address can differ slightly more from the entry in the DPL.

nlow: The address can differ significantly from the entry in the DPL.

exportService (O)

String (6)

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:

nexact: The company name must be identical to the entry in the DPL.

nhigh: (default) The company name cannot differ significantly from the entry in the DPL.

nmedium: The company name can differ slightly more from the entry in the DPL.

nlow: The company name can differ significantly from the entry in the DPL.

exportService (O)

String (6)

exportService_nameWeight

Degree of correlation between a customer’s name and an entry in the DPL before a match occurs. This field can contain one of these values:

nexact: The name must be identical to the entry in the DPL.

nhigh: (default) The name cannot differ significantly from the entry in the DPL.

nmedium: The name can differ slightly more from the entry in the DPL.

nlow: The name can differ significantly the entry in the DPL.

exportService (O)

String (6)

exportService_run

Indicates whether to include exportService in your request. The field can contain one of these values:

ntrue: Include the service in your request.

nfalse: (default) Do not include the service in your request.

exportService (O)

String (5)

exportService_sanctionsLists

Use this field to specify which list(s) you want checked with the request. The reply will include the list name as well as the response data.

To check against multiple lists, enter multiple list codes separated by a caret (^).

For more information, see Restricted and Denied Parties List.

exportService (O)

String (255)

item_#_export

List of ISO country or region codes for countries to which the product can be exported. For more information, see Country or Region and Territory Postal System Categories.

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. government’s 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.

See Numbered Elements.

exportService (O)

String (no length limit)

item_#_noExport

List of ISO country or region codes for countries to which the product cannot be exported. For more information, see Country or Region and Territory Postal System Categories.

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.

See Numbered Elements.

exportService (O)

String (no length limit)

item_#_productCode

Type of product that the item contains, which is also used to determine the category within which the product falls (electronic, handling, physical, service, or shipping).

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.

See Numbered Elements.

davService (O)

exportService (O)

String (30)

item_#_productName

Name of the product.

See Numbered Elements.

davService (O)

exportService (O)

String (30)

item_#_productSKU

Product’s identifier code.

See Numbered Elements.

davService (O)

exportService (O)

String (30)

item_#_quantity

Quantity of the product being purchased.

See Numbered Elements.

davService (O)

exportService (O)

Integer (10)

item_#_unitPrice

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.

See Numbered Elements.

davService (R)

exportService (R)

String (15)

merchantID

Your CyberSource merchant ID. Use the same merchant ID for evaluation, testing, and production.

davService (R)

exportService (R)

String (30)

merchantReferenceCode

Merchant-generated order reference or tracking number.

davService (R)

exportService (R)

String (50)

shipTo_city

City of the shipping address.

davService (R)

String (50)

shipTo_country

Country of the shipping address. Use the two-character country or region codes (see Country or Region and Territory Postal System Categories). For exportService, billTo_country is used if shipTo_country is not present.

davService (R)

exportService (O)

String (2)

shipTo_firstName

First name of the recipient.

exportService (O)

String (60)

shipTo_lastName

Last name of the recipient.

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 State, Province, and Territory Codes for the United States and Canada.

The default value for shipTo_state is the value of 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)