Home > API Fields


API Fields

 

This guide is a supplement to the credit card guide and PIN debit guide. This supplement provides information about features and fields that are used in addition to the information that is in the credit card guide and PIN debit guide.

 

When you send a request that includes card-present data, you must include the basic fields required for every credit card or PIN debit request. For information about these basic fields, see Credit Card Services Using the Simple Order API and PIN Debit Processing Using the Simple Order API.

 

XML Schema Versions

For general information about the XML schema versions, see Getting Started with Cybersource Advanced for the Simple Order API.The following table specifies the Simple Order API version to use for each processor for clear-text card-present transactions.

Table 5Simple Order API XML Schema Versions
for Card-Present Transactions

Processor

Version for Clear Text Transactions

American Express Direct

1.138 or later

Chase Paymentech Solutions

1.25 or later

Credit Mutuel-CIC

1.151 or later

FDC Nashville Global

1.24 or later

FDMS Nashville

1.29 or later

GPN

1.26 or later

JCN Gateway

1.26 or later

OmniPay Direct

1.25 or later

Prosa

1.168 or later

RBS WorldPay Atlanta

1.48 or later

SIX

1.138 or later

TSYS Acquiring Solutions

1.13 or later

Worldpay VAP—Worldpay VAP was previously called Litle. Litle was purchased by Vantiv, which was then purchased by Worldpay VAP. If you have any questions, contact your account manager at Worldpay VAP.

1.58 or later

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 6Data Type Definitions

Data Type

Description

Date and time

Format is YYYY-MM-DDThh:mm:ssZ, where:

nT separates the date and the time

nZ indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT)

Example  2020-01-11T22:47:57Z equals January 11, 2020, at 22:47:57 (10:47:57 p.m.).

Integer

Whole number {..., -3, -2, -1, 0, 1, 2, 3, ...}

String

Sequence of letters, numbers, spaces, and special characters