Order-Level Fields

Table 16

Order-Level Fields for TSYS Acquiring Solutions

CyberSource Field Name	TSYS Acquiring Solutions Field Name	Description	Used By: Required (R) or Optional (O)	Data Type & Length
ccCaptureService_purchasingLevel	No corresponding TSYS Acquiring Solutions field	Flag that indicates the capture request includes Level III data. Set the value for this field to 3. For more information, see Requesting Captures and Credits with Level III Data.	Level III ■ Visa (R for captures; not used for credits) ■ Mastercard (R for captures; not used for credits)	String (1)
ccCreditService_purchasingLevel	No corresponding TSYS Acquiring Solutions field	Flag that indicates the credit request includes Level III data. Set the value for this field to 3. For more information, see Requesting Captures and Credits with Level III Data.	Level III ■ Visa (R for credits; not used for captures) ■ Mastercard (R for credits; not used for captures)	String (1)
invoiceHeader_merchantVATRegistrationNumber	Merchant VAT Registration Number	Your government-assigned tax identification number.	Level III ■ Visa (O)	String (20)
invoiceHeader_purchaserOrderDate	Order Date	Date the order was processed. Format: YYMMDD.	Level III ■ Visa (O)	String (6)
invoiceHeader_purchaserVATRegistrationNumber	Customer VAT Registration Number	Customer’s government-assigned tax identification number.	Level III ■ Visa (O)	String (13)
invoiceHeader_summaryCommodityCode	Summary Commodity Code	International description code of the overall order’s goods or services. Contact your acquirer for a list of codes.	Level III ■ Visa (R)	String (4)
invoiceHeader_userPO	No corresponding TSYS Acquiring Solutions field	Value used by your customer to identify the order. This value is typically a purchase order number.	Level II ■ Visa (R for purchase/procurement cards; otherwise O. Do not use all zeros or nines.) ■ Mastercard (R for purchase/procurement cards; otherwise O. Do not use all zeros or nines.)   Level III ■ Visa (R for purchase/procurement cards; otherwise O. Do not use all zeros or nines.) ■ Mastercard (R for purchase/procurement cards; otherwise O. Do not use all zeros or nines.)	String (25)
invoiceHeader_vatInvoiceReferenceNumber	Unique VAT Invoice Reference Number	VAT invoice number associated with the transaction.	Level III ■ Visa (O)	String (15)
otherTax_alternateTaxAmount	Alternate Tax Amount	Total amount of alternate tax for the order.	Level III ■ Mastercard (O)	String (10)
otherTax_alternateTaxIndicator	Alternate Tax Amount Indicator	Flag that indicates whether the alternate tax amount (otherTax_alternateTaxAmount) is included in the request. Possible values: ■ 0: alternate tax amount is not included in the request. ■ 1: alternate tax amount is included in the request.	Level III ■ Mastercard (O)	String (1)
otherTax_localTaxAmount	Local Tax	Sales tax for the order.	Level III ■ Visa (O) ■ Mastercard (O)	String (13)
otherTax_localTaxIndicator	Local Tax Included Flag	Flag that indicates whether local sales tax is included in the order total. Possible values: ■ 0: local sales tax not included ■ 1: local sales tax included ■ 2: tax exempt order If you do not provide this value, CyberSource sets this field to one of the following values: ■ 0 if you set Local Tax = 0 or do not provide a Local Tax ■ 1 if you set Local Tax > 0 Important For GSA (General Services Administration) purchasing cards, tax is required in order to qualify for Level III when processing with TSYS Acquiring Solutions. Therefore, the only valid Level III value for this field for GSA cards is 1. If you have any questions or concerns, contact your acquirer.	Level III ■ Visa (O) ■ Mastercard (O)	String (1)
otherTax_nationalTaxAmount	National Tax Amount	National tax for the order.	Level III ■ Visa (O) ■ Mastercard (O)	String (13)
otherTax_nationalTaxIndicator	National Tax Included Flag	Flag that indicates whether a national tax is included in the order total. Possible values: ■ 0: national tax not included ■ 1: national tax included If you do not provide this value, CyberSource sets this field to 1 if you provide a National Tax Amount greater than 0.	Level III ■ Visa (O) ■ Mastercard (O)	String (1)
otherTax_vatTaxAmount	VAT/Tax Amount	Total amount of VAT or other tax included in the order.	Level III ■ Visa (O)	String (13)
otherTax_vatTaxRate	VAT/Tax Rate	Rate of VAT or other tax for the order. Example 0.0400 (=4%) Valid range: 0.0001 to 0.9999 (0.01% to 99.99%)	Level III ■ Visa (O)	String (6)
purchaseTotals_discountAmount	Discount Amount	Total discount applied to the order. For example: a 20.00 discount off the order total.	Level III ■ Visa (O)	String (13)
purchaseTotals_dutyAmount	Duty Amount	Total charges for any import or export duties included in the order.	Level III ■ Visa (O) ■ Mastercard (O)	String (13)
purchaseTotals_freightAmount	Freight Amount	Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include purchaseTotals_grandTotalAmount.	Level III ■ Visa (O) ■ Mastercard (O)	String (13)
purchaseTotals_grandTotalAmount	No corresponding TSYS Acquiring Solutions field	Grand total for the entire capture or credit request.	Level III ■ Visa (R) ■ Mastercard (R)	String (15)
shipFrom_postalCode	Ship From Postal/ZIP Code	Postal code for the address from which the goods are shipped, which is used to determine nexus. The default is the postal code associated with your CyberSource account. The postal code must consist of 5 to 9 digits. If the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 If the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha] [space][numeric][alpha] [numeric] Example A1B 2C4	Level III ■ Visa (O) ■ Mastercard (Recommended for best rate. Do not use all zeros or nines.)	String (10)
shipTo_country	Destination Country Code	Country of the shipping address. Use the two-character ISO Standard Country Codes.	Level III ■ Visa (Recommended for best rate) ■ Mastercard (O but recommended)	String (2)
shipTo_postalCode	Destination Postal/ZIP Code	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   This value is the same as the value for shipFrom_postalCode when your customer takes possession of the items at your location. The postal code must consist of 5 to 9 digits.	Level III ■ Visa (Recommended for best rate) ■ Mastercard (Recommended for best rate. Do not use all zeros or nines.)	String (10)
shipTo_state	No corresponding TSYS Acquiring Solutions field	State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada.	If any shipping information is in the request, this field is required for CyberSource front-end processing.	String (2)