eCommerce API Fields

The following API fields must be considered when submitting an eCommerce transaction and should only be populated if they apply to your implementation. eCommerce transactions include all direct marketing fields.

Field Name Length
Type
Description
0190 e-Commerce Indicator (EC) 1
alphanumeric
This value must be presented in any e-commerce transaction. For returns, the value must be the same as the value of the original sale. Valid values are:
5 = 3-D Secure Compliant
6 = Non-Authenticated 3-D Secure
7 = Channel Encrypted
0191 Electronic Goods Indicator 1
alphanumeric
Valid values:
D = Digital Goods
P = Physical Goods
0192 Program Protocol* 1
numeric
Used to indicate the type of 3- D secure protocol used. Valid values:
Blank - Not a 3D secure transaction
1 - 3D secure transaction, version 1.0
2 - 3D secure transaction, version 2.0
0193 Direct Server Transaction ID* 1-36
alphanumeric
Required version for 3-D secure version 2.0
(API Field 0192 = 2)
This data is generated by the directory server during the authentication transaction and passed back to the merchant with the authentication results.
Allowed Values: Variable
0194 CAVV/UCAF/Tran Stain* 1-40
alphanumeric
Used for a 3-D, SPA, or SET transaction. This field contains a unique value calculated by applying a secure algorithm to the XID.
0195 XID* 1-40
alphanumeric
Used in a 3-D, SPA, or SET transaction.
This field contains a value assigned as a unique transaction identifier. It allows an alternate form of identifying the transaction without divulging the credit card account number in the response to the verification process.
0196 CAVV Response* 1
numeric
Used in a 3-D transaction:
Blank = CAVV not validated
0 = CAVV not validated due to erroneous data submitted
1 = CAVV failed
2 = CAVV passed
3 = CAVV validation could not be performed (issuer attempt incomplete)
4 = CAVV validation could not be performed (issuer system error)

* In Fields required for 3D Secure Transactions where the ECI is 5 and the site is a participating merchant in the MasterCard or Visa card authentication process, the authentication response needs to be presented at the time of authorization and settlement.

Direct Marketing

Below are the API field requirements for the direct marketing industry.

Field Name Length
Type
Description
0054 POS Entry Mode 2
numeric
01 - Manual/Key Entry
12 - Credential on File.
0711 Shipping Date 6
date
Date the merchandise was shipped to the customer. Format: MMDDYY
0712 Charge Description 1
numeric
Identifies the type of direct marketing charge. Valid values are:
1 = Single transaction mail/telephone order
2 = Recurring mail order transaction
3 = Mail order installment payment
4 = Unknown mail order transaction or IVR/VRU PINless Debit
9 = Call center PINless debit
0713 Clearing Sequence Count 2
numeric
Contains the total number of payments or installments to be made on this account.
0714 Clearing Sequence Number 2
numeric
Contains the sequence number of the payment or installment associated with the charge. The value should be between 1 and the clearing sequence count (API field 0713).
0715 Order Number 10
alphanumeric
Contains the purchase order or invoice number associated with this charge. May be the same as contents of reference number (API field 0007).
0716 Ship to ZIP 5-9
alphanumeric
Ship code where the merchandise is to be delivered.
0717 Item 1 Text 40
alphanumeric
Description of charges. This field is required along with API field 0720.
0718 Item 2 Text 40
alphanumeric
Description of charges. Required if there is an Item Code 2 (API field 0721).
0719 Item 3 Text 40
alphanumeric
Description of charges. Required if there is an Item Code 3 (API field 0722).
0720 Item Code 1 4-23
numeric
SubField 1: Item code describing type of product purchased (max size 4, type N)
SubField 2: Item quantity (max size 3, type N)
SubField 3: Item amount (max size 14, type C)
Format: NNNN;NNN;NNNNNNNNNNN.NN
Valid Examples:
720,23;1;13.42 (This example includes all subfields, item code, quantity, amt.)
720,2;2.35 (This example is quantity + amt only.)
720,453 (This example is item code only. This is an example of legacy use.)
0721 Item Code 2 4-23
numeric
Item code describing type of product purchased. Required if there is an Item 2 Text. Refer to description for field 720.
0722 Item Code 3 4-23
numeric
Item code describing type of product purchased. Required if there is an Item 3 Text. Refer to description for field 720.
0723 Recurring Payments status 1
alphanumeric
Flag indicating status of recurring payment (Card on File transaction)
Valid values are:
F - First Payment
S - Subsequent scheduled recurring payment (i.e., regular payment)
U - Unscheduled recurring payment/purchase
0724 Ship to Address Line 1 35
alphanumeric
If different than the billing street address.
0725 Ship to Address Line 2 35
alphanumeric
If different than the billing street address and an additional line is necessary.
0726 Ship to City 20
alphanumeric
If different than the billing city.
0727 Ship to State 2
alphanumeric
If different than the billing state.
0732
error_outline
note

e-Commerce field migrated to 191.

0733 Item 4 Text 40
alphanumeric
Description of charges. Required if there is an Item Code 4 (API field 0735).
0734 Item 5 Text 40
alphanumeric
Description of charges. Required if there is an Item Code 5 (API field 0736).
0735 Item Code 4 4-23
numeric
Item code describing type of product purchased. Required if there is an Item 4 Text. Refer to description for field 0720.
0736 Item Code 5 4-23
numeric
Item code describing type of product purchased. Required if there is an Item 5 Text. Refer to description for field 720
0738 Recurring compliance data 1-50
alphanumeric
Contains compliance data that merchants should retain and then return unaltered in the next recurring/card on file transaction.

error_outline
important

MOTO and eCommerce indicator fields are required for Direct Marketing integrations.

Fields 712 and 190 are required on all direct marking transactions and must contain the same value.

  • If the transaction is MOTO, set the appropriate value in field 712.
  • If the transaction is eCommerce, set the appropriate value in field 190.
  • Once the appropriate value is placed into 712 or 190, set the same value in the other field*.

Examples:

Moto Single Transaction 712 = 1 190 = 1

Channel Encrypted eCommerce Transaction 712 = 7 190 = 7

Tabulated Data Fields

Tabulated data is a field type that supports multiple values in a single input field. The data separator in a tabulated field is a semi-colon (;).

A field must be enabled with tabulated data before it can have multiple values included. If the TPP interface module supports tabulated data, the module must be added to the *TableizedSupport (a section of the admproc.txt file).

The Direct Marketing tabulated fields are 0720, 0721, 0722, 0735 and 0736.

error_outline
note

While not all values are listed as supported in both fields 712 and 190, Fusebox will accept these values in both fields and use them properly in the Third Party Processor Interfaces.