Field

Description

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

Data Type & Length

aggregated_auth_indicator

Flag for a mass transit transaction that indicates whether the authorization is aggregated. Possible values:

nY: Aggregated

nN: Not aggregated

This field is supported only for mass transit transactions.

See Mass Transit Transactions.

ics_auth (O)

String (1)

auth_capture_date

Date on which the customer initiated a contactless transit transaction.

Format: MMDD

This field is supported only for mass transit transactions.

See Mass Transit Transactions.

ics_auth (O)

String (4)

auth_deferred_auth_indicator

Indicates whether the authorization request was delayed because connectivity was interrupted. Possible values:

nY: Deferred authorization

nN (default): Not a deferred authorization

The value for this field corresponds to the following two data items in the TC 33 capture file¹:

nFirst data item:

lRecord: CP01 TCR0

lPosition: 160-163

lField: Message Reason Code

nSecond data item:

lRecord: CP01 TCR7

lPosition: 150-151

lField: Transit Transaction Type Indicator

This field is supported only for mass transit transactions.

See Mass Transit Transactions.

ics_auth (O)

String (1)

bill_address1

Payment card billing street address as it appears in the issuer’s records.

FDMS Nashville

When the street name is numeric, it must be sent in numeric format. For example, if the address is One First Street, it must be sent as 1 1st Street.

ics_auth:

nFDMS Nashville: R when keyed; not used when swiped.

nTSYS Acquiring Solutions: R when keyed and bill_payment is true.

nAll other processors: O

FDMS Nashville: String (20)

All other processors: String (60)

bill_address2

Used for additional address information. For example:
Attention: Accounts Payable

FDMS Nashville

bill_address1 and bill_address2 together cannot exceed 20 characters.

ics_auth (O)

FDMS Nashville: String (20)

All other processors: String (60)

bill_city

Payment card billing city.

ics_auth:

nChase Paymentech Solutions: O

nCredit Mutuel-CIC: O

nOmniPay Direct: O

nSIX: O

nTSYS Acquiring Solutions: R when keyed and bill_payment is true.

nWorldpay VAP: O

nAll other processors: not used.

String (50)

bill_country

Payment card billing country. Use the ISO Standard Country Codes.

ics_auth:

nChase Paymentech Solutions: O

nCredit Mutuel-CIC: O

nOmniPay Direct: O

nSIX: O

nTSYS Acquiring Solutions: R when keyed and bill_payment is true.

nWorldpay VAP: O

nAll other processors: not used.

String (2)

bill_payment

Indicates payment for bill or payment towards existing contractual loan. For information about Visa Bill Payments and Visa Debt Repayments, see Credit Card Services Using the SCMP API.

Possible values:

nfalse (default): Not a bill payment or loan payment.

ntrue: Bill payment or loan payment.

ics_auth (O)

String (5)

bill_state

Payment card billing state or province. Use the State, Province, and Territory Codes for the United States and Canada.

ics_auth:

nChase Paymentech Solutions: O

nCredit Mutuel-CIC: O

nOmniPay Direct: O

nSIX: O

nTSYS Acquiring Solutions: R when keyed and bill_payment is true.

nWorldpay VAP: O

nAll other processors: not used.

String (2)

bill_zip

Postal code for billing address. Postal code must consist of 5 to 9 digits.

When the billing country is the U.S., the 9-digit postal code must follow this format:
[5 digits][dash][4 digits]

Example  12345-6789

When the billing country is Canada, the 6-digit postal code must follow this format:
[alpha][numeric][alpha][space][numeric][alpha]
[numeric]

Example  A1B 2C3

ics_auth:

nFDMS Nashville: R when keyed and the address is in the U.S. or Canada. O when keyed and the address is not in the U.S. or Canada. Not used when swiped.

nRBS WorldPay Atlanta: when keyed, include this field for best card-present keyed rates.

nTSYS Acquiring Solutions: R when keyed and bill_payment is true.

nAll other processors: O.

String (10)

card_present

Indicates whether the card is present at the time of the transaction. Possible values:

nN: Card is not present.

nY: Card is present.

ics_auth:

nFDMS Nashville: not used.

nAll other processors: R.

String (1)

card_type

Three-digit value that indicates the card type. For the possible values, see Card Types.

ics_auth
(R for Carte Blanche and JCB. O for other card types.)

Important  
Cybersource strongly recommends that you send the card type even when it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type.

String (3)

cat_level

Type of cardholder-activated terminal. Possible values:

n1: Automated dispensing machine

n2: Self-service terminal

n3: Limited amount terminal

n4: In-flight commerce (IFC) terminal

n5: Radio frequency device

n6: Mobile acceptance terminal

n7: Electronic cash register

n8: E-commerce device at your location

n9: Terminal or cash register that uses a dial-up connection to connect to the transaction processing network

Chase Paymentech Solutions

Only values 1, 2, and 3 are supported.

FDC Nashville Global

Only values 7, 8, and 9 are supported.

GPN

Only values 6, 7, 8, and 9 are supported.

JCN Gateway

Only values 6, 7, 8, and 9 are supported.

Prosa

Values 1 through 9 are supported.

TSYS Acquiring Solutions

Only value 6 is supported.

ics_auth:

nChase Paymentech Solutions: R when terminal_id is included in the request; otherwise, O.

nFDC Nashville Global: O for EMV transactions; otherwise, not used.

nGPN: R.

nJCN Gateway: R.

nProsa: R.

nTSYS Acquiring Solutions: R for transactions from mobile devices; otherwise, not used.

nAll other processors: not used.

Nonnegative integer (1)

comments

Brief description or comments for the order.

This value is not sent to the processor. Instead, the value is forwarded to the Cybersource reporting software.

This field is supported only for Cybersource integrations as described in Cybersource Integration.

ics_auth (O)

String (255)

currency

Currency used for order. For possible values, see the ISO Standard Currency Codes.

ics_auth (R)

String (5)

customer_cc_cv_indicator

Indicates whether a CVN code was sent. Possible values:

n0 (default): CVN service not requested. This default is used when you do not include customer_cc_cv_number in the request.

n1 (default): CVN service requested and supported. This default is used when you include customer_cc_cv_number in the request.

n2: CVN on payment card is illegible.

n9: CVN not imprinted on payment card.

ics_auth:

nFDMS Nashville: R for American Express cards; otherwise, O.

nTSYS Acquiring Solutions: O when keyed; otherwise, not used.

nAll other processors: O.

Nonnegative integer (1)

customer_cc_cv_number

CVN. See the CVN information in Credit Card Services Using the SCMP API.

ics_auth:

nFDMS Nashville: R for American Express or when swiped; otherwise, O.

nTSYS Acquiring Solutions: O when keyed; otherwise, not used.

nAll other processors: O.

Nonnegative integer (4)

customer_cc_expmo

Two-digit month in which payment card expires. Format: MM.
Possible values: 01 through 12. Leading 0 is required.

ics_auth:

nFDMS Nashville: R.

nAll other processors: R when keyed.¹

String (2)

customer_cc_expyr

Four-digit year in which payment card expires. Format: YYYY.

ics_auth:

nFDMS Nashville: R.

nAll other processors: R when keyed.¹

Nonnegative integer (4)

customer_cc_number

Payment card number.

ics_auth:

nFDMS Nashville: R.

nAll other processors: R when keyed.

FDMS Nashville: Nonnegative integer (19)

All other processors: Nonnegative integer (20)

customer_email

Customer’s email address, including full domain name.
Format: name@host.domain

ics_auth:

nChase Paymentech Solutions: O

nCredit Mutuel-CIC: O

nOmniPay Direct: O

nSIX: O

nTSYS Acquiring Solutions: R when keyed and bill_payment is true.

nWorldpay VAP: O

nAll other processors: not used.

String (255)

customer_firstname

Customer’s first name. Value should match value on card.

ics_auth:

nChase Paymentech Solutions: O

nCredit Mutuel-CIC: O

nOmniPay Direct: O

nSIX: O

nTSYS Acquiring Solutions: R when keyed and bill_payment is true.

nWorldpay VAP: O

nAll other processors: not used.

String (60)

customer_lastname

Customer’s last name. Value should match value on card.

ics_auth:

nChase Paymentech Solutions: O

nCredit Mutuel-CIC: O

nOmniPay Direct: O

nRBS WorldPay Atlanta: O

nSIX: O

nTSYS Acquiring Solutions: R when keyed and bill_payment is true.

nWorldpay VAP: O

nAll other processors: not used.

String (60)

customer_phone

Customer’s phone number. Cybersource recommends that you include the country code when order is from outside the U.S.

ics_auth:

nChase Paymentech Solutions: O

nCredit Mutuel-CIC: O

nOmniPay Direct: O

nSIX: O

nTSYS Acquiring Solutions: O

nWorldpay VAP: O

nAll other processors: not used.

String (15)

debt_recovery_indicator

Flag for a mass transit transaction that indicates whether the purpose of the authorization is to recover debt. Possible values:

nY: Debt recovery transaction

nN: Not a debt recovery transaction

The value for this field corresponds to the following data in the TC 33 capture file¹:

nRecord: CP01 TCR7

nPosition: 150-151

nField: Transit Transaction Type Indicator

This field is supported only for mass transit transactions.

See Mass Transit Transactions.

ics_auth (O)

String (1)

e_commerce_indicator

Type of transaction. For a card-present transaction, you must set this field to retail.

ics_auth (R)

String (13)

grand_total_amount

Grand total for the order. You must include either this field or offer0 and the offer-level field amount. For information about offers and grand totals, see Getting Started with Cybersource Advanced for the SCMP API.

ics_auth
(See description)

Decimal (15)

ics_applications

Cybersource services to process for the request.

ics_auth (R)

String (255)

industry_datatype

Indicates whether the transaction includes mass transit transaction (MTT) data. You must set this field to transit in order for MTT data to be sent to the processor.

When this field is not set to transit or is not included in the request, Cybersource does not send MTT data to the processor.

This field is supported only for mass transit transactions.

See Mass Transit Transactions.

ics_auth
(R for MTT transactions.)

String (10)

jpo_jcca_terminal_id

Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Cybersource.

The difference between this field and the terminal_id field is that you can define terminal_id, but jpo_jcca_terminal_id is defined by the JCCA and is used only in Japan.

This field is supported only on JCN Gateway.

ics_auth (O)

Integer (13)

jpo_jis2_track_data

Japanese Industrial Standard Type 2 (JIS2) track data from the front of the card.

This field is supported only on JCN Gateway.

ics_auth (O)

ics_credit (O)

String (69)

merchandise_code

Identifier for the merchandise. This field is supported only on the processors listed in this field description.

American Express Direct

Value:

n1000: Gift card

JCN Gateway

This value must be right justified. In Japan, this value is called a goods code.

ics_auth (O)

Integer (7)

merchant_id

Your Cybersource merchant ID.

ics_auth (R)

String (30)

merchant_ref_number

Merchant-generated order reference or tracking number. Cybersource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with Cybersource Advanced for the SCMP API.

FDC Nashville Global

The value for this field must be numeric and must be less than 9 digits. When you do not send a valid value, Cybersource creates one for you. However, the value is not returned to you, so you cannot use the merchant reference number to track the order.

ics_auth (R)

String (50)

partner_original_transaction_id

Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal’s software and to Cybersource. Therefore, you can use this value to reconcile transactions between Cybersource and the terminal’s software.

Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software.

This field is supported only for Cybersource integrations as described in Cybersource Integration.

ics_auth (O)

ics_auth_reversal (O)

ics_bill (O)

ics_credit (O)

String (32)

partner_sdk_version

Version of the software installed on the POS terminal.

Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software.

This field is supported only for Cybersource integrations as described in Cybersource Integration.

ics_auth (O)

ics_credit (O)

String (32)

pos_device_id

Value created by the client software that uniquely identifies the POS device.

Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software.

This field is supported only for Cybersource integrations as described in Cybersource Integration.

ics_auth (O)

ics_credit (O)

String (32)

pos_entry_mode

Method of entering payment card information into the POS terminal. Possible values:

ncontact: Read from direct contact with chip card.

ncontactless: Read from a contactless interface using chip data.

nkeyed: Manually keyed into POS terminal. This value is not supported on OmniPay Direct.

nmsd: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct.

nswiped: Read from payment card magnetic stripe.

The contact, contactless, and msd values are supported only for EMV transactions. See Europay, Mastercard, Visa (EMV).

ics_auth (R)

String (11)

sales_slip_number

Transaction identifier that you generate.

This field is supported only on JCN Gateway.

ics_auth (R)

ics_credit (R for stand-alone credits)

Integer (5)

ship_to_address1

First line of shipping address.

ics_auth
(R when shipping address information is included in the request; otherwise, O.)

String (60)

ship_to_address2

Second line of shipping address.

ics_auth (O)

String (60)

ship_to_city

City of shipping address.

ics_auth
(R when shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, O.)

String (50)

ship_to_country

Country of shipping address. Use the ISO Standard Country Codes.

ics_auth
(R when shipping address information is included in the request; otherwise, O.)

String (2)

ship_to_firstname

First name of the person receiving the shipment.

ics_auth (O)

String (60)

ship_to_lastname

Last name of the person receiving the shipment.

ics_auth (O)

String (60)

ship_to_state

State or province to ship the product to. Use the State, Province, and Territory Codes for the United States and Canada.

ics_auth
(R when shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, O.)

String (2)

ship_to_zip

Postal code for the shipping address. The postal code must consist of 5 to 9 digits.

When the shipping country is the U.S., the
9-digit postal code must follow this format:
[5 digits][dash][4 digits]

Example  12345-6789

When the shipping country is Canada, the
6-digit postal code must follow this format:
[alpha][numeric][alpha][space][numeric][alpha]
[numeric]

Example  A1B 2C3

ics_auth
(R when shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, O.)

String (10)

store_and_forward_indicator

When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored.

Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software.

Possible values:

nY: Transaction was stored and then forwarded.

nN (default): Transaction was not stored and then forwarded.

This field is supported only for Cybersource integrations as described in Cybersource Integration, but is not supported for Credit Mutuel-CIC.

ics_auth (O)

ics_credit (O)

String (1)

terminal_capability

POS terminal’s capability. Possible values:

n1: Terminal has a magnetic stripe reader only.

n2: Terminal has a magnetic stripe reader and manual entry capability.

n3: Terminal has manual entry capability only.

n4: Terminal can read chip cards.

n5: Terminal can read contactless chip cards; cannot use contact to read chip cards.

For an EMV transaction, the value of this field must be 4 or 5. See Europay, Mastercard, Visa (EMV).

ccAuthService:

nR for the following processors:

lAmerican Express Direct

lChase Paymentech Solutions

lCredit Mutuel-CIC

lFDC Nashville Global

lFDMS Nashville

lOmniPay Direct

lProsa

lSIX

lWorldpay VAP

nO for the following processors:

lGPN

lJCN Gateway

lRBS WorldPay Atlanta

lTSYS Acquiring Solutions

Integer (1)

terminal_card_capture_capability

Indicates whether the terminal can capture the card. Possible values:

n1: Terminal can capture card.

n0: Terminal cannot capture card.

This field is supported only for Cybersource integrations as described in Cybersource Integration, but is not supported for FDC Nashville Global or SIX.

ics_auth (O)

ics_credit (O)

String (1)

terminal_cvm_capabilities_#

Complete list of cardholder verification methods (CVMs) supported by the terminal. Possible values:

nPIN

nSignature

This field is supported only for Cybersource integrations as described in Cybersource Integration.

ics_auth (O)

ics_credit (O)

String (15)

terminal_id

Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements.

FDC Nashville Global

To have your account configured to support this field, contact Cybersource Customer Support. This value must be a value that FDC Nashville Global issued to you.

ics_auth:

nO for the following processors. When not included in the request, Cybersource uses the value in your Cybersource account.

lAmerican Express Direct

lCredit Mutuel-CIC

lFDC Nashville Global

lProsa

lSIX

nChase Paymentech Solutions: O. When you include this field in your request, you must also include cat_level.

nFDMS Nashville: Cybersource uses the value in your Cybersource account.

nOmniPay Direct: O.

nFor the following processors this field is not used.

lGPN

lJCN Gateway

lRBS WorldPay Atlanta

lTSYS Acquiring Solutions

lWorldpay VAP

String (8)

terminal_id_alternate

Identifier for an alternate terminal at your retail location. You define the value for this field.

This field is supported only for Mastercard transactions on FDC Nashville Global. Use the terminal_id field to identify the main terminal at your retail location. When your retail location has multiple terminals, use this terminal_id_alternate field to identify the terminal used for the transaction.

This field is a pass-through, which means that Cybersource does not check the value or modify the value in any way before sending it to the processor.

ics_auth:

nFDC Nashville Global: O for Mastercard transactions; otherwise, not used.

nAll other processors: not used.

String (8)

terminal_input_capabilities_#

Complete list of card input methods supported by the terminal. Possible values:

nKeyed: Terminal can accept card data that is entered manually.

nSwiped: Terminal can accept card data from a magnetic stripe reader.

nContact: Terminal can accept card data in EMV contact mode.

nContactless: Terminal can accept card data in EMV contactless mode.

nBarCode: Terminal can read bar codes.

nQRcode: Terminal can read QR codes.

nOCR: Terminal can perform optical character recognition (OCT).

This field is supported only for Cybersource integrations as described in Cybersource Integration.

ics_auth (O)

ics_credit (O)

String (15)

terminal_output_capability

Indicates whether the terminal can print or display messages. Possible values:

n1: Neither

n2: Print only

n3: Display only

n4: Print and display

This field is supported only for Cybersource integrations as described in Cybersource Integration.

ics_auth (O)

ics_credit (O)

String (1)

terminal_pin_capability

Maximum PIN length that the terminal can capture. Possible values:

n0: No PIN capture capability

n1: PIN capture capability unknown

n4: Four characters

n5: Five characters

n6: Six characters

n7: Seven characters

n8: Eight characters

n9: Nine characters

n10: Ten characters

n11: Eleven characters

n12: Twelve characters

This field is supported only for Cybersource integrations as described in Cybersource Integration, but is not supported on FDC Nashville Global.

ics_auth (R for PIN transactions)

ics_credit (R for PIN transactions)

Integer (2)

terminal_serial_number

Terminal serial number assigned by the hardware manufacturer.

Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software.

This field is supported only for Cybersource integrations as described in Cybersource Integration.

ics_auth (O)

ics_credit (O)

String (32)

terminal_type

Type of terminal. Possible values:

n21: Attended terminal, online only

n22: Attended terminal, offline with online capability

n23: Attended terminal, offline only

n24: Unattended terminal, online only

n25: Unattended terminal, offline with online capability

n26: Unattended terminal, offline only

This field is supported only for Cybersource integrations as described in Cybersource Integration.

ics_auth (O)

ics_auth_reversal (O)

ics_credit (O)

String (2)

transaction_local_date_time

Date and time at your physical location.

Format: YYYYMMDDhhmmss, where:
YYYY = year
MM = month
DD = day
hh = hour
mm = minutes
ss = seconds

ics_auth:

nR for the following processors:

lAmerican Express Direct

lCredit Mutuel-CIC

lFDC Nashville Global

lSIX

nO for all other processors.

String (14)

transportation_mode

Mode of transportation or type of transportation-related payment. Possible values:

n00: Use this value for:

lDebt recovery

lMore than one transportation mode

lUnknown transportation mode

n01: Urban bus

n02: Interurban bus

n03: Light train mass transit

n04: Train

n05: Commuter train

n06: Water-borne vehicle

n07: Toll

n08: Parking

n09: Taxi

n10: High-speed train

n11: Rural bus

n12: Express commuter train

n13: Paratransit

n14: Self-driving vehicle

n15: Coach

n16: Locomotive

n17: Powered motor coach

n18: Trailer

n19: Regional train

n20: Inter-city transportation

n21: Funicular train

n22: Cable car

This field is supported only for mass transit transactions.

See Mass Transit Transactions.

ics_auth (O)

String (2)

1   This field is optional when your Cybersource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date. Important  It is your responsibility to determine whether a field is required for the transaction you are requesting.