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 SCMP API and PIN Debit Processing Using the SCMP API.

 

Formatting Restrictions

Unless otherwise noted, all fields are order and case insensitive and the fields accept special characters such as @, #, and %.

Values for request-level and offer-level fields must not contain carets (^) or colons (:). However, they can contain embedded spaces and any other printable characters. When you use more than one consecutive space, the extra spaces are removed before the request is sent to the processor.

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

Data Type

Description

Date and time

Format is YYYY-MM-DDThhmmssZ, where:

nT separates the date and the time

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

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

Decimal

Number that includes a decimal point

Example  23.45, -0.1, 4.0, 90809.0468

Integer

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

Nonnegative integer

Whole number greater than or equal to zero {0, 1, 2, 3, ...}

Positive integer

Whole number greater than zero {1, 2, 3, ...}

String

Sequence of letters, numbers, spaces, and special characters