MOTO and eCommerce API Fields

This page details the API fields for eCommerce, 3DS Pass Thru and Direct Marketing:

eCommerce

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

0190 (e-Commerce Indicator (EC)

• Description: 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:
  • 5 = 3-D Secure Compliant
    
  • 6 = Non-Authenticated 3-D Secure
  • 7 = Channel Encrypted
• Length: 1
• Data Type: alphanumeric

0191 (Electronic Goods Indicator)

• Description:
• Valid values:
  • D = Digital Goods
  • P = Physical Goods
• Length: 1
• Data Type: alphanumeric

Field 0198 (eCommerce Registered User Indicator)

• Description:
• Valid Values:
  • Y = Yes, the cardholder has a registered profile with login credentials on the merchant’s website.
  • N = No, the cardholder does not have registered profile with login credentials on the merchant’s website, may only shop as a guest.
• Length: 1
• Data Type: alphanumeric

0199 (eCommerce Registered User Profile Change Date)

• Description: Date of the last change to a Registered User’s profile on a merchant’s website.
• Valid Value: Format: DDMMYYYY Example: 31122021
• Length: 8
• Data Type: numeric

* 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.

3DS Pass Thru

0192 Program Protocol*)

• Description: 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
• Length: 1
• Data Type: numeric

0193 (Direct Server Transaction ID*)

• Description: 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
• Length: 1 - 36
• Data Type: alphanumeric

0194 (CAVV/UCAF/Tran Stain*)

• Description: Used for a 3-D, SPA, or SET transaction. This field contains a unique value calculated by applying a secure algorithm to the XID. Note: The merchant’s website communicates directly with Visa to get the 3D Secure verification response value. This communication does not occur through Fusebox. The 3D Secure verification response value that the merchant gets directly from Visa is sent to Fusebox in API field 0194.
• Length: 1 - 40
• Data Type: alphanumeric - Base 256 Flat ASCII HEX

0196 (CAVV Response*)

• Description: Used in a 3-D transaction.
• Valid Values:
  • 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)
• Length: 1
• Data Type: numeric

* 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

0054 (POS Entry Mode)

• Description: 01 - Manual/Key Entry
• Length: 2
• Data Type: numeric

0711 (Shipping Date)

• Description: Date the merchandise was shipped to the customer. Format: MMDDYY
• Length: 6
• Data Type: date

0712 (Charge Description)

• Field Name:
• Description: Identifies the type of direct marketing charge.
• Valid values:
  • 1 = Single transaction mail/telephone order
  • 2 = Recurring mail order transaction
  • 3 = Mail order installment payment
• Length: 1
• Data Type: numeric

0713 (Clearing Sequence Count)

• Description: Contains the total number of payments or installments to be made on this account.
• Length: 2
• Data Type: numeric

0714 (Clearing Sequence Number)

• Description: Contains the sequence number of the payment or installment associated with the charge.
• Valid Value: The value should be between 1 and the clearing sequence count (API field 0713).
• Length: 2
• Data Type: numeric

0715 (Order Number)

• Description: Contains the purchase order or invoice number associated with this charge. May be the same as contents of reference number (API field 0007).
• Length: 10
• Data Type: alphanumeric

0716 (Ship to ZIP)

• Description: Ship code where the merchandise is to be delivered.
• Length: 5 - 9
• Data Type: alphanumeric

0717 (Item 1 Text)

• Description: Description of charges. This field is required along with API field 0720.
• Length: 40
• Data Type: alphanumeric

0718 (Item 2 Text)

• Description: Description of charges. Required if there is an Item Code 2 (API field 0721).
• Length: 40
• Data Type: alphanumeric

0719 (Item 3 Text)

• Description: Description of charges. Required if there is an Item Code 3 (API field 0722).
• Length: 40
• Data Type: alphanumeric

0720 (Item Code 1)

• Description:
  • SubField 1: Item code describing type of product purchased (max size 4, type
  • 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.)
• Length: 4 - 23
• Data Type: numeric

0721 (Item Code 2)

• Description: Item code describing type of product purchased. Required if there is an Item 2 Text. Refer to description for field 720.
• Length: 4 - 23
• Data Type: numeric

0722 (Item Code 3)

• Description: Item code describing type of product purchased. Required if there is an Item 3 Text. Refer to description for field 720.
• Length: 4 - 23
• Data Type: numeric

0723 (Item Code 3)

• Description: Flag indicating status of recurring payment (Card on File transaction)
• Valid values:
  • F - First Payment
  • S - Subsequent scheduled recurring payment (i.e., regular payment)
  • U - Unscheduled recurring payment/purchase
• Length: 1
• Data Type: alphanumeric

0724 (Ship to Address Line 1)

• Description: If different than the billing street address.
• Length: 35
• Data Type: alphanumeric

0725 (Ship to Address Line 2)

• Description: If different than the billing street address and an additional line is necessary.
• Length: 35
• Data Type: alphanumeric

0726 (Ship to City)

• Description: If different than the billing city.
• Length: 20
• Data Type: alphanumeric

0727 (Ship to State)

• Description: If different than the billing state.
• Length: 2
• Data Type: alphanumeric

0732 (e-Commerce field migrated to 191)

0733 (Item 4 Text)

• Description: Description of charges. Required if there is an Item Code 4 (API field 0735).
• Length: 40
• Data Type: alphanumeric

0734 (Item 5 Text)

• Description: Description of charges. Required if there is an Item Code 5 (API field 0736).
• Length: 40
• Data Type: alphanumeric

0735 (Item Code 4)

• Description: Item code describing type of product purchased. Required if there is an Item 4 Text. Refer to description for field 0720.
• Length: 4 - 23
• Data Type: numeric

0736 (Item Code 5)

• Description: Item code describing type of product purchased. Required if there is an Item 5 Text. Refer to description for field 720.
• Length: 4 - 23
• Data Type: numeric

0738 (Recurring Compliance Data)

• Description: Contains compliance data that merchants should retain and then return unaltered in the next recurring/card on file transaction.
• Length: 1 - 50
• Data Type: alphanumeric

Fields 712 and 190

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.

• previousMOTO and eCommerce
• nextEcommerce Examples