Field

Description

Used By: Required (R) or Optional (O)

Data Type & Length

bill_address1

First line of the billing address.

ics_dav (R)

ics_export (R)

String (60)

bill_address2

Second line of the billing address.

ics_dav (O)

ics_export (O)

String (60)

bill_address3 and bill_address4

Third and fourth line of the billing address.

ics_dav (O)

String (60)

bill_city

City of the billing address. For ics_dav, if ship_city is not provided, bill_city is used in its place.

ics_dav (R)

ics_export (R)

String (50)

bill_country

Country or region of the billing address. Use the two-character country or region codes (see Country or Region and Territory Postal System Categories). For the ics_dav service, if the ship_to_country field is not provided, the bill_country field is used in its place.

ics_dav (R)

ics_export (R)

String (2)

bill_state

State or province of the billing address. Use the two-character codes located in the Support Center. For the ics_dav service, if shipping address information is not provided, the bill_state field information is used in place of the ship_to_state field.

Required if the value of bill_state is CA or US.

ics_dav (O)

ics_export (O)

String (2)

bill_zip

Postal code of the billing address. Make sure to send only valid and well-formed data. Required only if the bill_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

ics_dav (R for U.S. and Canada)

String (10)

comments

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

ics_dav (O)

ics_export (O)

String

company_name

Company name of person buying the product.

Important  This field or customer_firstname and customer_lastname must be present. Otherwise, your request will fail.

ics_export

String (60)

customer_account_id

Optional customer’s account ID, tracking number, reward number, or other unique number that you assign to the customer for the purpose that you choose.

ics_dav (O)

ics_export (O)

String (100)

customer_email

Customer’s email address, including the full domain name submitted in the form name@host.domain, such as jdoe@cybersource.com.

ics_export (R)

String (255)

customer_firstname

Customer’s first name.

Important  If you submit this field, you must also submit customer_lastname. Alternatively, you can submit company_name field instead of customer_firstname and customer_lastname. Otherwise, your request will fail.

ics_export

String (60)

customer_hostname

DNS resolved host name from the customer_ipaddress field.

ics_export (O)

String (40)

customer_ipaddress

IP address of the customer, for example, 10.1.27.63.

ics_export (O)

String (15)

customer_lastname

Customer’s last name.

Important  If you submit this field, you must also submit customer_firstname. Alternatively, you can submit company_name field instead of customer_firstname and customer_lastname. Otherwise, your request will fail.

ics_export

String (60)

export_address_operator

Parts of the customer’s information that must match with an entry in the DPL (denied parties list) before a match occurs. This field can contain one of the following 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.

ics_export (O)

String (6)

export_address_weight

Degree of correlation between a customer’s address and an entry in the DPL before a match occurs. This field can contain one of the following 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.

ics_export (O)

String (6)

export_company_weight

Degree of correlation between a company address and an entry in the DPL before a match occurs. This field can contain one of the following 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.

ics_export (O)

String (6)

export_name_weight

Degree of correlation between a customer’s name and an entry in the DPL before a match occurs. This field can contain one of the following 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.

ics_export (O)

String (6)

export_sanctions_lists

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.

ics_export (O)   

String (255)

ics_applications

ICS applications to process for the request.

At least one application must be specified in the request.

ics_dav (R)

ics_export (R)

String (255)

ignore_dav_result

When requesting the ics_dav service with other applications, the ignore_dav_result field enables you to continue processing the request even if the ics_dav service cannot verify the address. This field can contain one of the following values:

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

nno: (default) If the ics_dav service cannot verify the address, stop processing the request.

ics_dav (O)

String (3)

ignore_export_result

When requesting the ics_export service with other applications or if the denied parties list check is enabled for your merchant ID, the ignore_export_result field enables you to continue processing the request even if the order does not comply with export requirements. This field can contain one of the following values:

nyes: Ignore the results of export compliance and continue to process the request. The reply will include information about any matches with denied parties lists.

nno: (default) If the order does not pass export compliance, stop processing the request.

ics_export (O)

String (3)

merchant_id

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

ics_dav (R)

ics_export (R)

String (30)

merchant_ref_number

Merchant-generated order reference or tracking number.

ics_dav (R)

ics_export (R)

String (50)

offer0
   to 
offerN

Offers (line items of the order) for the request. At a minimum, offer0 must be present.

ics_dav (O)

ics_export (O)

String (50)

ship_to_address1

First line of the shipping address.

ics_dav (R)

String (60)

ship_to_address2
   to
ship_to_address4

Second to fourth line of the shipping address.

ics_dav (O)

String (60)

ship_to_city

City of the shipping address.

ics_dav (R)

String (50)

ship_to_country

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

ics_dav (R)

ics_export (O)

String (2)

ship_to_firstname

First name of the recipient.

ics_export (O)

String (60)

ship_to_lastname

Last name of the recipient.

ics_export (O)

String (60)

ship_to_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 the ship_to_state field is the value in the bill_state field. Required if the value of the ship_to_country field is CA or US.

ics_dav (O)

String (2)

ship_to_zip

Postal code of the shipping address. Required if the value of the ship_to_country field is CA or US.

ics_dav (O)

String (10)

timeout

Number of seconds the system waits before returning a time-out error. The default is 110.

ics_dav (O)

ics_export (O)

Positive integer (3)