API Fields

Formatting Restrictions

Unless otherwise noted, all field names are case sensitive and all fields accept special characters such as @, #, and %.

 

The values of the item_#_ fields must not contain carets (^) or colons (:) because these characters are reserved for use by the CyberSource services. Values for request-level and item-level fields must not contain new lines or carriage returns. However, they can contain embedded spaces and any other printable characters. CyberSource removes all leading and trailing spaces.

Data Type Definitions

 

For more information about these data types, see the World Wide Web Consortium (W3C) XML Schema Part 2: Datatypes Second Edition.

 

Table 4

Data Type Definitions

Data Type	Description
Integer	Whole number {..., -3, -2, -1, 0, 1, 2, 3, ...}
String	Sequence of letters, numbers, spaces, and special characters

 

Numbered Elements

 

The CyberSource XML schema includes several numbered elements. You can include these complex elements more than once in a request. For example, if a customer order includes more than one item, you must include multiple <item> elements in your request. Each item is numbered, starting with 0. The XML schema uses an id attribute in the item’s opening tag to indicate the number. For example:

<item id="0">

For the name-value pair field names, this tag is represented as item_0. In this portion of the field name, the underscore before the number does not indicate hierarchy in the XML schema. The item fields are generically referred to as item_#_<element name> in the documentation.

Below is an example of the numbered <item> element and the corresponding name-value pair field names. If you are using SOAP, the client contains a corresponding Item class.

 

Example 1

Numbered XML Schema Element Names and Name-Value Pair Field Names

XML Schema Element Names	Corresponding Name-Value Pair Field Names
<item id="0">   <unitPrice>   <quantity> </item>	item_0_unitPrice item_0_quantity
<item id="1">   <unitPrice>   <quantity> </item>	item_1_unitPrice item_1_quantity

 

When a request is in XML format and includes an <item> element, the element must include an id attribute. For example: <item id="0">.