CyberSource Level II Processing, Level III Processing Credit Card Services Developer Guide
PDF
ドキュメント
広告
広告
Title Page Level II and Level III Processing Using the SCMP API Supplement to Credit Card Services Using the SCMP API June 2017 CyberSource Corporation HQ | P.O. Box 8999 | San Francisco, CA 94128-8999 | Phone: 800-530-9095 CyberSource Contact Information For general information about our company, products, and services, go to http://www.cybersource.com. For sales questions about any CyberSource Service, email [email protected] or call 650-432-7350 or 888-330-2300 (toll free in the United States). For support information about any CyberSource Service, visit the Support Center at http://www.cybersource.com/support. Copyright © 2017 CyberSource Corporation. All rights reserved. CyberSource Corporation ("CyberSource") furnishes this document and the software described in this document under the applicable agreement between the reader of this document ("You") and CyberSource ("Agreement"). You may use this document and/or software only in accordance with the terms of the Agreement. Except as expressly set forth in the Agreement, the information contained in this document is subject to change without notice and therefore should not be interpreted in any way as a guarantee or warranty by CyberSource. CyberSource assumes no responsibility or liability for any errors that may appear in this document. The copyrighted software that accompanies this document is licensed to You for use only in strict accordance with the Agreement. You should read the Agreement carefully before using the software. Except as permitted by the Agreement, You may not reproduce any part of this document, store this document in a retrieval system, or transmit this document, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written consent of CyberSource. Restricted Rights Legends For Government or defense agencies. Use, duplication, or disclosure by the Government or defense agencies is subject to restrictions as set forth the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 and in similar clauses in the FAR and NASA FAR Supplement. For civilian agencies. Use, reproduction, or disclosure is subject to restrictions set forth in subparagraphs (a) through (d) of the Commercial Computer Software Restricted Rights clause at 52.227-19 and the limitations set forth in CyberSource Corporation's standard commercial agreement for this software. Unpublished rights reserved under the copyright laws of the United States. Trademarks Authorize.Net, eCheck.Net, and The Power of Payment are registered trademarks of CyberSource Corporation. CyberSource, CyberSource Payment Manager, CyberSource Risk Manager, CyberSource Decision Manager, and CyberSource Connect are trademarks and/or service marks of CyberSource Corporation. All other brands and product names are trademarks or registered trademarks of their respective owners. 2 CONTENTS Contents Recent Revisions to This Document About This Guide 7 Audience and Purpose Conventions 7 7 Related Documentation Customer Support Chapter 1 6 8 8 Introduction to Level II and Level III Processing Prerequisites for Level II Processing 9 Prerequisites for Level III Processing 10 Supported Processors and Card Types About Level II Data 11 About Level III Data 11 9 10 CyberSource Level II and Level III Data Processing 12 Relaxed Requirements for Address Data and Expiration Date Using Decimals and Strings Chapter 2 14 Requesting Captures and Credits with Level III Data 15 American Express Direct: Level II Offer-Level Fields Chapter 3 14 Requesting Captures and Credits with Level II Data Order-Level Fields 18 19 21 Chase Paymentech Solutions: Level II and Level III Processor Specification Used Order-Level Fields Offer-Level Fields 12 23 23 24 28 Level II and Level III Processing Using the SCMP API | June 2017 3 Contents Chapter 4 CyberSource through VisaNet: Level II and Level III Supported Acquirers Order-Level Fields Offer-Level Fields Chapter 5 33 35 43 FDC Compass: Level II and Level III Processor Specification Used Order-Level Fields Offer-Level Fields Chapter 6 Offer-Level Fields 53 Offer-Level Fields Offer-Level Fields Chapter 9 58 65 72 73 75 Processor Specification Offer-Level Fields Chapter 10 73 GPN: Level II and Level III Order-Level Fields Offer-Level Fields 77 77 78 81 Litle: Level II and Level III Order-Level Fields 70 71 FDMS South: Level II Order-Level Fields 57 57 FDMS Nashville: Level II Order-Level Fields Chapter 8 48 49 Processor Specification Chapter 7 48 FDC Nashville Global: Level II and Level III Order-Level Fields 33 85 86 89 Level II and Level III Processing Using the SCMP API | June 2017 4 Contents Chapter 11 OmniPay Direct: Level II and Level III Processor Specification Order-Level Fields 95 Offer-Level Fields 100 Examples Chapter 12 94 105 RBS WorldPay Atlanta: Level II and Level III Processor Specification Order-Level Fields Offer-Level Fields Chapter 13 94 108 108 109 113 TSYS Acquiring Solutions: Level II and Level III Processor Specification Order-Level Fields Offer-Level Fields 117 118 123 Appendix A Codes for Units of Measurement Appendix B Product Codes 117 127 134 Level II and Level III Processing Using the SCMP API | June 2017 5 Release Changes June 2017 CyberSource through VisaNet: added four new acquirers, which are listed in Chapter 4, "CyberSource through VisaNet: Level II and Level III," on page 33: Bank Sinarmas (Omise Ltd.) January 2017 Cathay United Bank (CUB) Promerica in Honduras and Nicaragua Taishin Bank Ltd. REVISIONS Recent Revisions to This Document CyberSource through VisaNet: added four new acquirers, which are listed in Chapter 4, "CyberSource through VisaNet: Level II and Level III," on page 33: Bangkok Bank Ltd. Citibank Hongkong and Macau United Overseas Bank (UOB) in Singapore and Vietnam United Overseas Bank (UOB) in Thailand OmniPay Direct: added support for Bank of America Merchant Services. See Chapter 11, "OmniPay Direct: Level II and Level III," on page 94. October 2016 OmniPay Direct: added examples for this processor. See "Examples," page 105. September 2016 All processors that support Level III transactions: updated description for amount field to specify that the value cannot be zero (0) for a Level III transaction. All processors: updated description for product_code field to specify when the field is required. All processors except CyberSource through VisaNet: updated the terminology in step 5 of "Requesting Captures and Credits with Level III Data," page 15. The step had previously referred to captures but it was updated to refer to credits. FDC Compass: update requirements for commodity_code. See "Offer-Level Fields," page 53. GPN: updated Level III requirements for the following offer-level fields: amount, commodity_ code, discount_amount, discount_rate, product_code, quantity, unit_of_measure. See "Offer-Level Fields," page 81. OmniPay Direct: added chapter for this processor. See Chapter 11, "OmniPay Direct: Level II and Level III," on page 94. March 2016 American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet, FDC Compass, FDC Nashville Global, FDMS South, and GPN: added support for relaxed requirements for address data and expiration dates. See "Relaxed Requirements for Address Data and Expiration Date," page 12. CyberSource through VisaNet: removed the Rosbank acquirer. October 2015 Added the CyberSource through VisaNet field names. See Chapter 4, "CyberSource through VisaNet: Level II and Level III," on page 33. Level II and Level III Processing Using the SCMP API | June 2017 6 ABOUT GUIDE About This Guide Audience and Purpose This guide is written for application developers who want to use the CyberSource SCMP API to integrate credit card processing with Level II or Level III data into their order management system. Implementing the CyberSource credit card services requires software development skills. You must write code that uses the API request and reply fields to integrate the credit card services with Level II or Level III data into your existing order management system. Conventions The following special statements are used in this document: A Note contains helpful suggestions or references to material not contained in this document. Note An Important statement contains information essential to successfully completing a task or learning a concept. Important The following text conventions are used in this document: Convention Meaning bold Field and service names in text; for example: Include the ics_applications field. italic Titles of documents Level II and Level III Processing Using the SCMP API | June 2017 7 About This Guide Convention Meaning screen text XML elements Code examples Values for API fields; for example: Set the ics_applications field to ics_auth. Related Documentation Getting Started with CyberSource Advanced for the SCMP API (PDF | HTML) describes how to get started using the SCMP API. Credit Card Services Using the SCMP API (PDF | HTML) describes how to integrate CyberSource payment processing services into your business. Refer to the Support Center for complete CyberSource technical documentation: http://www.cybersource.com/support_center/support_documentation Customer Support For support information about any CyberSource service, visit the Support Center: http://www.cybersource.com/support Level II and Level III Processing Using the SCMP API | June 2017 8 CHAPTER Introduction to Level II and Level III Processing 1 This addendum to Credit Card Services Using the SCMP API describes: Level II processing for American Express, Visa, and Mastercard Level III processing for Visa and Mastercard After this introductory chapter, there is a chapter for each processor that supports Level II or Level III. Important This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. Prerequisites for Level II Processing To activate Level II processing for American Express, contact American Express and CyberSource Customer Support. On OmniPay Direct, when you are ready to go live with Level II processing, contact CyberSource Customer Support to have your account configured to process Level II data. If your account is not enabled, and you try to send Level II transactions on OmniPay Direct, you will receive an error for invalid data. Level II and Level III Processing Using the SCMP API | June 2017 9 Chapter 1 Introduction to Level II and Level III Processing Prerequisites for Level III Processing Check with your processor to determine whether you need to add Level III processing to your contract or account setup. When you are ready to go live with Level III processing, contact CyberSource Customer Support to have your account configured to process Level III data. If your account is not enabled, and you try to send Level III transactions, you will receive an error for invalid data. Supported Processors and Card Types Table 1 Supported Processors and Card Types Processor Level II Card Types Supported Level III Card Types Supported American Express Direct American Express None Chase Paymentech Solutions Visa Mastercard American Express Visa Mastercard CyberSource through VisaNet Visa Mastercard American Express Visa Mastercard FDC Compass Visa Mastercard American Express Visa Mastercard FDC Nashville Global Visa Mastercard American Express Visa Mastercard FDMS Nashville Visa Mastercard None FDMS South Visa Mastercard None GPN Visa Mastercard Visa Mastercard Litle Visa Mastercard American Express Visa Mastercard OmniPay Direct Visa Mastercard Visa Mastercard RBS WorldPay Atlanta Visa Mastercard Visa Mastercard TSYS Acquiring Solutions Visa Mastercard Visa Mastercard Level II and Level III Processing Using the SCMP API | June 2017 10 Chapter 1 Introduction to Level II and Level III Processing About Level II Data Level II cards, which are also called Type II cards, provide customers with additional information on their credit card statements about their purchases. Level II cards enable customers to easily track the amount of sales tax they pay and to reconcile transactions with a unique customer code. There are two categories of Level II cards: Business/corporate cards are given by businesses to employees for business-related expenses such as travel and entertainment or for corporate supplies and services. Purchase/procurement cards are used by businesses for expenses such as supplies and services. These cards are often used as replacements for purchase orders. Each processor supports a different set of Level II fields. If your business is not in the United States, you must use additional fields. About Level III Data You can provide Level III data for purchase/procurement cards, which are used by businesses for expenses such as supplies and services. These cards are often used as replacements for purchase orders. The Level III data is forwarded to the company that made the purchase, and it enables the company to manage its purchasing activities. Level II and Level III Processing Using the SCMP API | June 2017 11 Chapter 1 Introduction to Level II and Level III Processing CyberSource Level II and Level III Data Processing CyberSource does not store the Level II and Level III data. Instead, it functions as a passthrough service for the data. If you request multiple partial captures or credits for an order, you must include the Level II and Level III data in each request. CyberSource enforces only a minimal level of field validation to avoid interfering with the business policies between you and the companies that purchase your goods and services. Note CyberSource temporarily disables your account’s Level III processing capability and contacts you if your Level III transactions produce batching errors when the information is sent to your processor. When this happens, your request is not rejected, but the reply message from CyberSource includes a field indicating that the Level III information was ignored and was not sent to the processor. For captures, the reply field is bill_purchasing_level3_enabled. For credits, the reply field is credit_purchasing_level3_enabled. The possible values for the reply fields are: Y: the Level III data was included in the request to the processor. N: the Level III data was not included in the request to the processor. Relaxed Requirements for Address Data and Expiration Date Services: Authorization Stand-alone credit Processors: American Express Direct Chase Paymentech Solutions CyberSource through VisaNet FDC Compass FDC Nashville Global FDMS South GPN OmniPay Direct Level II and Level III Processing Using the SCMP API | June 2017 12 Chapter 1 Introduction to Level II and Level III Processing To enable relaxed requirements for address data and expiration date, contact CyberSource Customer Support to have your account configured for this feature. Historically, this data was mandated by CyberSource. With the advent of digital payments and an increasingly global e-commerce environment, CyberSource decided to relax the requirements for address data and expiration date. Relaxed requirements for address data and expiration date make the following fields optional for payment processing: bill_address1 bill_city bill_country bill_state bill_zip: if you include this field in your request, you must also include bill_country. customer_cc_expmo: if you include this field in your request, you must also include customer_cc_expyr. customer_cc_expyr: if you include this field in your request, you must also include customer_cc_expmo. customer_email customer_firstname customer_lastname Important When relaxed requirements for address data and expiration date are enabled for your CyberSource account, and your service request does not include one or more of the fields in the preceding list, you increase the risk of declined transactions and fraud depending on your location, your processor, and the cardholder's issuing bank. It is your responsibility to determine whether a field is required for the transaction you are requesting. For example, effective October 2014, an issuing bank can decline an authorization request for a recurring transaction with a Visa Europe card if the expiration date is incorrect, invalid, or missing. If you do not provide the correct expiration date for a recurring transaction the authorization request may be declined. Level II and Level III Processing Using the SCMP API | June 2017 13 Chapter 1 Introduction to Level II and Level III Processing Using Decimals and Strings CyberSource uses decimal points in all amount and tax rate fields; CyberSource does not use implied decimal points. For example, if the amount of the product being purchased is 29.95, set that field to 29.95. For tax rates used with Level III transactions, you need to include a decimal point in the value. For example, if a tax rate is 1%, you should set that field to 0.01. For many of the fields described in this document, Visa and Mastercard permit different lengths for alphanumeric (string) input. CyberSource accepts any length you provide. If the value you provide is longer than the payment card company permits, CyberSource truncates the value, keeping the left-most portion of the value. If the value you provide is shorter than the payment card company requires, CyberSource pads the field before sending it to the processor. Requesting Captures and Credits with Level II Data To include Level II data in a capture or credit request: Step 1 Authorize a credit card payment. Step 2 Capture the authorization. Include the following information in the capture request: Level II data: see the chapter in this document for the processor you are using. Also see "Using Decimals and Strings," page 14. Important If you omit required Level II fields from a request, the transaction does not result in an error. Instead, it is processed as a regular non-Level II transaction. However, your processor could charge you penalties or increase your fees. Contact your processor to ensure you understand your processor’s specific requirements for Level II transactions. Basic fields required for every capture request. For more information, see Credit Card Services Using the SCMP API. Level II and Level III Processing Using the SCMP API | June 2017 14 Chapter 1 Step 3 Introduction to Level II and Level III Processing If necessary, credit the payment. Include the following information in the credit request: Level II data: see the chapter in this document for the processor you are using. Also see "Using Decimals and Strings," page 14. Important Note If you omit required Level II fields from a request, the transaction does not result in an error. Instead, it is processed as a regular non-Level II transaction. However, your processor could charge you penalties or increase your fees. Contact your processor to ensure you understand your processor’s specific requirements for Level II transactions. OmniPay Direct does not require Level II data for credits. When you include Level II data in a credit request for OmniPay Direct, CyberSource does not pass the Level II data to OmniPay Direct. RBS WorldPay Atlanta does not require Level II data for credits. Note Basic fields required for every credit request. For more information, see Credit Card Services Using the SCMP API. Requesting Captures and Credits with Level III Data To include Level III data in a capture or credit request: Step 1 Authorize a credit card payment. CyberSource recommends that for Level III transactions you include the total order amount in the authorization request, even though it is not required. Doing so ensures that CyberSource uses your total order amount and that the capture or credit request total amount matches the original authorization total amount. The field to use in the authorization request is grand_total_amount. Level II and Level III Processing Using the SCMP API | June 2017 15 Chapter 1 Step 2 Introduction to Level II and Level III Processing Capture the authorization. Include the following information in the capture request: Level II and Level III data: see the chapter in this document for the processor you are using. Also see "Using Decimals and Strings," page 14. Purchasing level field: the field name is purchasing_level. Set this field to 3 to indicate that the request includes Level III data. Basic fields required for every capture request. For more information, see Credit Card Services Using the SCMP API. Step 3 For all processors except CyberSource through VisaNet, check the capture reply message. The reply message includes a field that indicates whether CyberSource sent the Level III information to the processor. The field name is bill_purchasing_level3_enabled. The possible values are: Y: the account is enabled for Level III transactions. The Level III data was included in the request to the processor. N: the account is not enabled for Level III transactions. The Level III data was not included in the request to the processor. If your account is not enabled for Level III data or if you did not include the purchasing level field in your request, CyberSource does not include the Level III data in the request sent to the processor. Step 4 If necessary, credit the payment. Include the following information in the credit request: Level II and Level III data: see the chapter in this document for the processor you are using. Also see "Using Decimals and Strings," page 14. Note OmniPay Direct does not require Level III data for credits. When you include Level III data in a credit request for OmniPay Direct, CyberSource does not pass the Level II data to OmniPay Direct. RBS WorldPay Atlanta does not require Level II data for credits. Note Level II and Level III Processing Using the SCMP API | June 2017 16 Chapter 1 Introduction to Level II and Level III Processing Purchasing level field: the field name is purchasing_level. Set this field to 3 to indicate that the request includes Level III data. Basic fields required for every credit request. For more information, see Credit Card Services Using the SCMP API. Step 5 For all processors except CyberSource through VisaNet, check the credit reply message. The reply message includes a field that indicates whether CyberSource sent the Level III information to the processor. The field name is credit_purchasing_level3_enabled. The possible values are: Y: the account is enabled for Level III transactions. The Level III data was included in the request to the processor. N: the account is not enabled for Level III transactions. The Level III data was not included in the request to the processor. If your account is not enabled for Level III data or if you did not include the purchasing level field in your request, CyberSource does not include the Level III data in the request sent to the processor. Level II and Level III Processing Using the SCMP API | June 2017 17 CHAPTER American Express Direct: Level II 2 On American Express Direct, Level II data is supported only for merchants in the U.S. who are doing business in U.S. dollars. Note Important Important This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. When you send a capture or credit request with Level II data, you must include the required fields for every capture or credit request. For information about the non-Level-II fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Level II and Level III Processing Using the SCMP API | June 2017 18 Chapter 2 American Express Direct: Level II Order-Level Fields Table 2 Order-Level Fields for American Express Direct CyberSource Field Name American Express Direct Field Name Description Used By (Required/ Optional) Data Type & Length amexdata_taa1 Charge Description 1 Four Transaction Advice Addendum fields. These fields are used to display descriptive information about a transaction on your customer’s American Express card statement. If you are sending any TAA fields, start with amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be ignored. Level II String (40) amexdata_taa2 amexdata_taa3 amexdata_taa4 Charge Description 2 Charge Description 3 Charge Description 4 American Express (Optional but recommended) Contact CyberSource Customer Support if you plan to use these fields so that your account can be configured appropriately. customer_ firstname Requestor Name Requestor’s first name. Include this value when the cardmember is not the person who ordered or purchased the product or service. Level II American Express (O) String (see description) This field and customer_lastname together should not exceed 37 characters. This field is optional if your CyberSource account is configured for relaxed requirements for address data. See "Relaxed Requirements for Address Data and Expiration Date," page 12. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. Level II and Level III Processing Using the SCMP API | June 2017 19 Chapter 2 Table 2 American Express Direct: Level II Order-Level Fields for American Express Direct (Continued) CyberSource Field Name American Express Direct Field Name Description Used By (Required/ Optional) Data Type & Length customer_ lastname Requestor Name Requestor’s last name. Include this value when the cardmember is not the person who ordered or purchased the product or service. Level II String (see description) American Express (O) This field and customer_firstname together should not exceed 37 characters. This field is optional if your CyberSource account is configured for relaxed requirements for address data. See "Relaxed Requirements for Address Data and Expiration Date," page 12. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. ship_to_zip Ship-to Postal Code Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level II When the shipping country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] String (10) American Express (See description) 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 The postal code is required. You can provide the postal code by including ship_to_zip in the request or by making sure the postal code is set for your CyberSource account. user_po Cardmember Reference Number Value used by your customer to identify the order. This value is typically a purchase order number, cost center, or project number. Level II and Level III Processing Using the SCMP API | June 2017 Level II String (17) American Express (O) 20 Chapter 2 American Express Direct: Level II Offer-Level Fields Table 3 Offer-Level Fields for American Express Direct CyberSource Field Name American Express Direct Field Name Description Used By (Required/ Optional) Data Type & Length amount Charge Item Amount 1 Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Level II Decimal (12) Charge Item Quantity 1 Quantity of the product being purchased. The default value is 1. No corresponding American Express Direct field Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. quantity invoice_number Level II and Level III Processing Using the SCMP API | June 2017 American Express (Optional but recommended) Level II American Express (Optional but recommended) Level II Nonnegative integer (3) String (23) American Express (O) 21 Chapter 2 Table 3 American Express Direct: Level II Offer-Level Fields for American Express Direct (Continued) CyberSource Field Name American Express Direct Field Name Description Used By (Required/ Optional) Data Type & Length tax_amount Total Tax Amount Total tax to apply to the product. CyberSource adds the tax_amount values for all the offer lines to calculate the Total Tax Amount that is sent to the processor. Level II Decimal (12) American Express (R) The tax_amount value cannot be negative. This field is additive. For example, if you include the following offer lines: offer0=amount:10.00^ quantity:1^tax_amount: 0.80 offer1=amount:20.00^ quantity:1^tax_amount: 1.60 the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included. The tax_amount and the amount must be in the same currency. If you want to include tax_amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. Level II and Level III Processing Using the SCMP API | June 2017 22 Important CHAPTER Chase Paymentech Solutions: Level II and Level III 3 This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. . Important When you send a capture or credit request with Level II and/or Level III data, you must include the required fields for every capture or credit request. For information about the non-Level-II and non-Level-III fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Processor Specification Used The specifications that CyberSource used to implement Level III processing for Chase Paymentech Solutions are: Paymentech’s 120-Byte Technical Specification, Rev 2.0.0, December 8, 2003 Paymentech’s 96-Byte and 120-Byte Batch Technical Specification Addendum, Rev. 2.0.0, April 1, 2004 The records referenced are: Procurement Level 3 — Visa: Order Level Record, Record #1, Record #2 Procurement Level 3 — Mastercard: Order Level Record, Record #1, Record #2 Level II and Level III Processing Using the SCMP API | June 2017 23 Chapter 3 Chase Paymentech Solutions: Level II and Level III Order-Level Fields Table 4 Order-Level Fields for Chase Paymentech Solutions CyberSource Field Name Chase Paymentech Solutions Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_ amount Alternate Tax Amount Total amount of alternate tax for the order. Level III Decimal (10) alternate_tax_id Alternate Tax ID Your tax ID number to use for the alternate tax amount. Required if you set Alternate Tax Amount to any value, including zero. You may send this field without sending Alternate Tax Amount. amexdata_taa1 TAA1 amexdata_taa2 TAA2 amexdata_taa3 TAA3 amexdata_taa4 TAA4 Four Transaction Advice Addendum fields. These fields are used to display descriptive information about a transaction on your customer’s American Express card statement. If you are sending any TAA fields, start with amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be ignored. Mastercard (O) Level III Mastercard (See description) Level II String (15) String (40) American Express (See description) Contact CyberSource Customer Support if you plan to use these fields so that your account can be configured appropriately. The amexdata_taa1 field is required for Level II transactions for American Express cards for Chase Paymentech Solutions, but the other TAA fields are optional. However, if you are including the request ID (bill_request_id) in a Level II credit request, you are not required to include amexdata_taa1. duty_amount Duty Amount Total charges for any import or export duties included in the order. Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (Required for Level III interchange) Visa: Decimal (13) Mastercard: Decimal (10) Mastercard (Required for Level III interchange) 24 Chapter 3 Table 4 Chase Paymentech Solutions: Level II and Level III Order-Level Fields for Chase Paymentech Solutions (Continued) CyberSource Field Name Chase Paymentech Solutions Field Name Description Used By (Required/ Optional) Data Type & Length freight_amount Freight Amount Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include grand_total_ amount. Level III Visa: Decimal (13) Visa (Required for Level III interchange) Mastercard (Required for Level III interchange) No corresponding Chase Paymentech Solutions field Grand total for the entire capture or credit request. order_discount_ amount Discount Amount Applied to Order Total discount applied to the order. For example: a 20.00 discount off the order total. purchasing_level No corresponding Chase Paymentech Solutions field Flag that indicates the capture or credit request includes Level III data. Set the value for this field to 3. See "Requesting Captures and Credits with Level III Data," page 15. Level III Ship From ZIP/ Postal 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. Level III grand_total_amount ship_from_zip If the billing country is the U.S., the 9digit postal code must follow this format: [5 digits][dash][4 digits] Level III Visa (R) Mastercard (R) Level III Mastercard: Decimal (10) Decimal (15) Decimal (13) Visa (Required for Level III interchange) Visa (R) Mastercard (R) Visa (O) Mastercard (Required for best rate. Do not use all zeros or nines.) String (1) String (10) Example 12345-6789 If the billing country is Canada, the 6digit postal code must follow this format: [alpha][numeric][alpha] [space][numeric][alpha] [numeric] Example A1B 2C4 Level II and Level III Processing Using the SCMP API | June 2017 25 Chapter 3 Table 4 Chase Paymentech Solutions: Level II and Level III Order-Level Fields for Chase Paymentech Solutions (Continued) CyberSource Field Name Chase Paymentech Solutions Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_country Destination Country Code Country of the shipping address. Use the two-character ISO Standard Country Codes. Level III String (2) ship_to_zip Destination ZIP/Postal 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] Visa (Required for best rate) Mastercard (Optional but recommended) Level III Visa (Required for best rate) Mastercard (Required for best rate. Do not use all zeros or nines.) String (10) Example A1B 2C3 This value is the same as the value for ship_from_zip when your customer takes possession of the items at your location. Level II and Level III Processing Using the SCMP API | June 2017 26 Chapter 3 Table 4 Chase Paymentech Solutions: Level II and Level III Order-Level Fields for Chase Paymentech Solutions (Continued) CyberSource Field Name Chase Paymentech Solutions Field Name Description Used By (Required/ Optional) Data Type & Length user_po Customer Reference Number Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. Level II String (25) Visa (Required for purchase/ procurement cards; optional otherwise) Mastercard (Required for purchase/ procurement cards; optional otherwise) American Express (Required for purchase/ procurement cards; optional otherwise) Level III vat_tax_amount vat_tax_rate Visa (Required for purchase/ procurement cards; optional otherwise) Mastercard (Required for purchase/ procurement cards; optional otherwise) VAT/Tax Amount Total amount of VAT or other tax included in the order. Level III VAT/Tax Rate Rate of VAT or other tax for the order. Level III Example 0.040 (=4%) Decimal (13) Visa (O) Decimal (4) Visa (O) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) Level II and Level III Processing Using the SCMP API | June 2017 27 Chapter 3 Chase Paymentech Solutions: Level II and Level III Offer-Level Fields Important Table 5 The maximum number of offer lines you can have in a Level III Chase Paymentech Solutions transaction is 98. If the number of offer lines exceeds 98, Chase Paymentech Solutions rejects the batch. Offer-Level Fields for Chase Paymentech Solutions CyberSource Field Name Chase Paymentech Solutions Field Name Description Used By (Required/ Optional) Data Type & Length amount Unit Cost Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Level II Decimal (13) Important For a Level III transaction, this value cannot be zero (0). commodity_code discount_amount Item Commodity Code Commodity code used to classify the item. Visa: Discount Amount for Line Item Discount applied to the item. Discount Indicator Visa (R) Mastercard (R) American Express (R) Level III Visa (R) Mastercard (R) Level III Flag that indicates whether the amount is discounted. Possible values: Y: amount is discounted N: amount is not discounted Visa (Required for Level III interchange) Visa: Decimal (13) Mastercard: Decimal (10) Mastercard (Required for Level III interchange) Level III String (12) Visa (Required for Level III interchange) Level III Mastercard: Discount Amount discount_indicator String (1) Mastercard (Required for Level III interchange) If you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets this field to Y. Level II and Level III Processing Using the SCMP API | June 2017 28 Chapter 3 Table 5 Chase Paymentech Solutions: Level II and Level III Offer-Level Fields for Chase Paymentech Solutions (Continued) CyberSource Field Name Chase Paymentech Solutions Field Name Description Used By (Required/ Optional) Data Type & Length gross_net_indicator Gross/Net Indicator Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: Level III String (1) Mastercard (R) Y: item amount includes tax amount N: item amount does not include tax amount invoice_number product_code No corresponding Chase Paymentech Solutions field Product Code Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is default. See Appendix B, "Product Codes," on page 134 for a list of valid values. For ics_auth, when you set this field to a value other than default or any of the values related to shipping and handling, the quantity, product_name, and merchant_product_sku fields are required. Level II and Level III Processing Using the SCMP API | June 2017 Level II Visa (O) Mastercard (O) American Express (O) String (23) Level III Visa (O) Mastercard (O) Level III Visa (Required for Level III interchange) Mastercard (Required for Level III interchange. Do not use all zeros or spaces.) String (12) 29 Chapter 3 Table 5 Chase Paymentech Solutions: Level II and Level III Offer-Level Fields for Chase Paymentech Solutions (Continued) CyberSource Field Name Chase Paymentech Solutions Field Name Description Used By (Required/ Optional) Data Type & Length product_name Description Text description of the item. Level III Visa: String (26) quantity Quantity Number of units of the item purchased. Must be a whole number. If you do not provide this value, CyberSource sets it to 1. Mastercard: String (35) Mastercard (Required for Level III interchange. Do not use all zeros or spaces.) Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (Required for Level III interchange) Visa (Required for Level III interchange) Visa: Integer (12) Mastercard: Integer (5) Mastercard (Required for Level III interchange. Do not use all zeros or spaces.) 30 Chapter 3 Table 5 Chase Paymentech Solutions: Level II and Level III Offer-Level Fields for Chase Paymentech Solutions (Continued) CyberSource Field Name Chase Paymentech Solutions Field Name Description Used By (Required/ Optional) Data Type & Length tax_amount Tax Amount Total tax to apply to the product. This value cannot be negative. The tax_amount field is additive. For example, if you include the following offer lines: Level II Visa: Decimal (13) offer0=amount:10.00^ quantity:1^tax_ amount: 0.80 offer1=amount:20.00^ quantity:1^tax_ amount: 1.60 Visa (R) Mastercard (R) American Express (R) Mastercard: Decimal (10) Level III Visa (R) Mastercard (R) the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included. The tax_amount and the amount must be in the same currency. If you want to include tax_ amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. tax_rate Tax Rate Tax rate applied to the item. Level III Visa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). Visa (O) Mastercard (R) Visa: Decimal (4) Mastercard: Decimal (7) Mastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). tax_type_applied total_amount Tax Type Applied Type of tax being applied to the item. Line Item Total Total amount for the item. Normally calculated as the unit price x quantity. Level II and Level III Processing Using the SCMP API | June 2017 Level III String (4) Mastercard (O) Level III Visa (R) Mastercard (R. Do not use all zeros or spaces.) Visa: Decimal (13) Mastercard: Decimal (10) 31 Chapter 3 Table 5 Chase Paymentech Solutions: Level II and Level III Offer-Level Fields for Chase Paymentech Solutions (Continued) CyberSource Field Name Chase Paymentech Solutions Field Name Description Used By (Required/ Optional) Data Type & Length unit_of_measure Unit of Measure Unit of measure, or unit of measure code, for the item. See Appendix A, "Codes for Units of Measurement," on page 127. Level III Visa: String (12) Level II and Level III Processing Using the SCMP API | June 2017 Visa (Required for Level III interchange) Mastercard: String (3) Mastercard (Required for Level III interchange. Do not use all zeros or spaces.) 32 Important Important CHAPTER CyberSource through VisaNet: Level II and Level III 4 This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. When you send a capture or credit request with Level II and/or Level III data, you must include the required fields for every capture or credit request. For information about the non-Level-II and non-Level III fields required for capture and credit requests, see Credit Card Services Using the SCMP API. CyberSource recommends including Level II data when submitting Level III data. The user_po field is required for all Level II and Level III requests. The purchasing_level field must be included in the Level III data request. Supported Acquirers The following CyberSource through VisaNet acquirers are supported for Level II processing: Absa Bank Asia Commercial Bank (ACB) Auckland Savings Bank (ASB) Australia and New Zealand Banking Group Limited (ANZ) Axis Bank Ltd. of India Bangkok Bank Ltd. Bank Muscat of Oman Bank of Ayudhya (BAY) Bank Sinarmas (Omise Ltd.) Banque Pour Le Commerce Exterieur Lao (BCEL) Barclays Bank Botswana Barclays Bank Mauritius Limited Level II and Level III Processing Using the SCMP API | June 2017 33 Chapter 4 CyberSource through VisaNet: Level II and Level III Barclays Bank of Ghana Limited, Barclays Bank of Tanzania Limited, and Barclays Bank of Uganda Limited Barclays Bank of Kenya Barclays Bank of Zambia Barclays Bank Seychelles Cathay United Bank (CUB) Citibank Hongkong and Macau Citibank Singapore Ltd. Commercial Bank of Qatar Habib Bank Ltd. (HBL) HDFC Bank Ltd. of India I&M Bank National Bank of Abu Dhabi (NBAD) Overseas Chinese Banking Corp (OCBC) Promerica in Honduras and Nicaragua Taishin Bank Ltd. United Overseas Bank (UOB) in Singapore and Vietnam United Overseas Bank (UOB) in Thailand Vantiv Vietcombank VietinBank Wing Lung Bank The following CyberSource through VisaNet acquirers are supported for Level III processing: Bank Sinarmas (Omise Ltd.) Cathay United Bank (CUB) Citibank Hongkong and Macau Taishin Bank Ltd. United Overseas Bank (UOB) in Thailand Level II and Level III Processing Using the SCMP API | June 2017 34 Chapter 4 CyberSource through VisaNet: Level II and Level III Order-Level Fields Table 6 Order-Level Fields for CyberSource through VisaNet CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length amexdata_taa1 amexDataTAA1 Level II String (40) amexdata_taa2 amexDataTAA2 amexdata_taa3 amexDataTAA3 amexdata_taa4 amexDataTAA4 Four Transaction Advice Addendum fields. These fields are used to display descriptive information about CPS item(s) on your customer’s American Express card statement. If you are sending any TAA fields, start with amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be ignored. American Express (O) Note These fields may be required depending on the processing method you use and if the customer provides charge description data. Contact CyberSource Customer Support if you plan to use these fields so that your account can be configured appropriately. authorized_contact_ name card_acceptor_ref_ number duty_amount authorized ContactName cardAcceptor RefNumber dutyAmount The name of the individual or the company contacted for company authorized purchases. Reference number that facilitates card acceptor/corporation communication and record keeping. Total charges for any import or export duties included in the order. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) String (36) String (25) Decimal (12) 35 Chapter 4 Table 6 CyberSource through VisaNet: Level II and Level III Order-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length duty_amount_sign dutyAmountSign Flag that indicates whether the duty amount should be interpreted as negative or positive. Possible values: Level III String (8) negative: duty amount is considered negative and represents a refund on the invoice positive: duty amount is considered positive and represents a cost on the invoice Visa (O) Mastercard (O) This field relates to the value in the duty_amount field. freight_amount freight_amount_sign freightAmount freightAmount Sign Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the amount field. Level III Flag that indicates if the freight (shipping) amount should be interpreted as negative or positive. Possible values: Level III negative: freight amount is considered negative and represents a refund on the invoice positive: freight amount is considered positive and represents a cost on the invoice Visa (O) Mastercard (O) Visa (O) Mastercard (O) Decimal (12) String (8) This field relates to the value in the freight_amount field. merchant_vat_ registration_number merchantVAT Registration Number Your government-assigned tax identification number. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) String (20) 36 Chapter 4 Table 6 CyberSource through VisaNet: Level II and Level III Order-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length national_tax_indicator nationalTax Included Flag that indicates whether a national tax is included in the order total. Possible values: Level II String (1) 0: national tax not included 1: national tax included This value must be 1 if the sum of all national_tax values > 0. Visa (Required if the sum of all national_tax values = 0; otherwise, optional.) Mastercard (Required if the sum of all national_tax values = 0; otherwise, optional.) American Express (Required if the sum of all national_tax values = 0; otherwise, optional.) If you do not include any national_tax values in your request, CyberSource does not include national_tax_indicator in the data it sends to the processor. Level III order_discount_amount discountAmount Total discount applied to the order. For example: a 20.00 discount off the order total. Level II and Level III Processing Using the SCMP API | June 2017 Visa (Required if the sum of all national_tax values = 0; otherwise, optional.) Mastercard (Required if the sum of all national_tax values = 0; otherwise, optional.) Level III Visa (O) Mastercard (O) Decimal (12) 37 Chapter 4 Table 6 CyberSource through VisaNet: Level II and Level III Order-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length order_discount_ amount_sign discountAmount Sign Flag that indicates whether the invoice level discount amount should be interpreted as negative or positive. Possible values: Level III String (8) negative: discount amount is considered as a discount refund for the invoice positive: discount amount is considered as a discount for the invoice Visa (O) Mastercard (O) Note A positive value for the discount amount is considered to reduce the amount of the invoice. This field relates to the value in the order_discount_amount field. order_discount_ management_indicator discount Management Indicator Flag that indicates how the merchant manages discounts. Possible values: 0: no invoice level discount Level III Visa (O) Mastercard (O) String (1) included 1: tax calculated on the postdiscount invoice total 2: tax calculated on the prediscount invoice total This field relates to the value in the order_discount_amount field. purchaser_order_date purchaser_vat_ registration_number purchasing_level purchaserOrder Date purchaserVAT Registration Number No corresponding CyberSource through VisaNet field Date the order was processed. Format: YYMMDD Customer’s governmentassigned tax identification number. Flag that indicates the capture or credit request includes Level III data. Set the value for this field to 3. See "Requesting Captures and Credits with Level III Data," page 15. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Level III Visa (R) Mastercard (R) String (6) String (20) String (1) 38 Chapter 4 Table 6 CyberSource through VisaNet: Level II and Level III Order-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length ship_from_zip shipFrom Address 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. Level III String (10) Visa (O) Mastercard (O) 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 ship_to_state state State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) String (3) 39 Chapter 4 Table 6 CyberSource through VisaNet: Level II and Level III Order-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_zip shipTo Address Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level II String (20) 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] Visa (O) Mastercard (O) American Express (O) Level III Visa (O) Mastercard (O) Example A1B 2C3 This value is the same as the value for ship_from_zip when your customer takes possession of the items at your location. summary_commodity_ code summary Commodity Code International description code of the overall order’s goods or services. Contact your acquirer for a list of codes. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) String (4) 40 Chapter 4 Table 6 CyberSource through VisaNet: Level II and Level III Order-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length tax_indicator localTax Included Flag that indicates whether an order is taxable. Possible values: Level II String (1) Y: the order is taxable. N: the order is not taxable. Visa (Required if the sum of all tax_amount values = 0; otherwise, optional.) Mastercard (Required if the sum of all tax_ amount values = 0; otherwise, optional.) American Express (Required if the sum of all tax_ amount values = 0; otherwise, optional.) This value must be Y if the sum of all tax_amount values > 0. If you do not include any tax_ amount values in your request, CyberSource does not include tax_indicator in the data it sends to the processor. Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (Required if the sum of all tax_amount values = 0; otherwise, optional.) Mastercard (Required if the sum of all tax_ amount values = 0; otherwise, optional.) 41 Chapter 4 Table 6 CyberSource through VisaNet: Level II and Level III Order-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length tax_management_ indicator taxManagement Indicator Flag that indicates how you calculate tax. Possible values: Level III String (1) 0: net prices with tax calculated at line item level total_tax_type_code totalTaxType Code 1: net prices with tax calculated at invoice level 2: gross prices with tax provided at line item level 3: gross prices with tax provided at invoice level 4: no tax applies on the invoice for the transaction For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the tax_amount field. Possible values: 056: sales tax (U.S only) TX~: all taxes (Canada only) Visa (O) Mastercard (O) Level II String (3) American Express (O) Note ~ = space. user_po customer Code Value that identifies your customer. Level II Visa (R) Mastercard (R) American Express (R) String with letters and numbers only (17) Level III vat_invoice_ref_number vat_tax_rate vatInvoice Reference Number vatTaxRate Invoice number associated with the transaction. Tax rate or other tax for the order. A maximum of 2 decimal places is allowed. Example 60% is 60.00 Level II and Level III Processing Using the SCMP API | June 2017 Visa (R) Mastercard (R) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) String (15) Decimal (4) 42 Chapter 4 Table 6 CyberSource through VisaNet: Level II and Level III Order-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length vat_tax_amount_sign vatTaxAmount Sign Flag that indicates if the VAT tax amount should be interpreted as negative or positive. Possible values: Level III String (8) negative: VAT amount is considered negative for the invoice positive: VAT amount is considered positive for the invoice Visa (O) Mastercard (O) This field relates to the value in the vat_tax_amount field. Offer-Level Fields Table 7 Offer-Level Fields for CyberSource through VisaNet CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length amount unitPrice Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. A maximum of 4 decimal places is allowed. CyberSource truncates the amount to the correct number of decimal places. Level II Decimal (12) American Express (O) Level III Visa (O) Mastercard (O) Important For a Level III transaction, this value cannot be zero (0). commodity_code commodityCode International description code used to classify the item. Contact your acquirer for a list of codes. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) String (12) 43 Chapter 4 Table 7 CyberSource through VisaNet: Level II and Level III Offer-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length discount_amount discountAmount Discount applied to the item. Level III Decimal (12) discount_management_ indicator discount Management Indicator Flag to indicate how you handle discount at the line item level. Possible values: 0: no line level discount Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) String (1) provided 1: tax was calculated on the post-discount line item total 2: tax was calculated on the pre-discount line item total Note Visa will inset 0 (zero) if an invalid value is included in this field. This field relates to the value in the discount_amount field. discount_rate discountRate Rate the item is discounted. A maximum of 2 decimal places is allowed. Example 5.25 (=5.25%) invoice_number invoiceNumber Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Decimal (5) String (15) 44 Chapter 4 Table 7 CyberSource through VisaNet: Level II and Level III Offer-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length national_tax nationalTax Amount Amount of national tax. Level II Decimal (12) This value cannot exceed 999999999999 (twelve 9s). This value cannot be negative. Visa (O) Mastercard (O) American Express (O) Level III product_code product_name quantity sign productCode productName quantity sign Product code for the item. Product name for the item. Number of units of the item purchased. A maximum of 4 decimal places is allowed. For example 1.1234. If you do not provide this value, CyberSource sets it to 1.0. Flag to indicate whether the line item should be interpreted as negative or positive. Possible values: negative positive Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Level II String (15) String (35) Decimal (12) American Express (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) String (8) This field relates to the value in the tax_amount field. Level II and Level III Processing Using the SCMP API | June 2017 45 Chapter 4 Table 7 CyberSource through VisaNet: Level II and Level III Offer-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length tax_amount localTax Amount Total tax to apply to the product. This value cannot exceed 999999999999 (twelve 9s). This value cannot be negative. Level II Decimal (12) This value is the amount of state or provincial tax included in the transaction amount. If you do not include this field in your request, CyberSource sets this field to the default value of 0. tax_rate taxRate Tax rate applied to the item. A maximum of 2 decimal places is allowed. Valid range is 0.01 to 99.99. The value can also be zero. Visa (O) Mastercard (O) American Express (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Decimal (4) For example: 60% is offer0:tax_ rate=60.00 25.5% is offer0:tax_ rate=25.5 33.33% is offer0:tax_ rate=33.33 tax_status_indicator total_amount type_of_supply taxStatus Indicator totalAmount typeOf Supply Flag to indicate whether tax is exempted or not included. Possible values: 0: tax not included 1: tax included 2: transaction is not subject to tax Total purchase amount for the item. Normally calculated as the unit price x quantity. Flag to indicate whether the purchase is categorized as goods or services. Possible values: 00: goods 01: services Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) String (1) Decimal (12) String (2) 46 Chapter 4 Table 7 CyberSource through VisaNet: Level II and Level III Offer-Level Fields for CyberSource through VisaNet (Continued) CyberSource Field Name CyberSource through VisaNet Field Name Description Used By (Required/ Optional) Data Type & Length unit_of_measure unitOfMeasure Unit of measure for the item. See "Codes for Units of Measurement," page 127. Level III String (12) Level II and Level III Processing Using the SCMP API | June 2017 Visa (O) Mastercard (O) 47 Important Important CHAPTER FDC Compass: Level II and Level III 5 This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. When you send a capture or credit request with Level II and/or Level III data, you must include the required fields for every capture or credit request. For information about the non-Level-II and non-Level-III fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Processor Specification Used The specification that CyberSource used to implement Level III processing for FDC Compass is the Compass 120-Byte Processing Technical Specification, Version 1.9, July 28, 2009. Level II and Level III Processing Using the SCMP API | June 2017 48 Chapter 5 FDC Compass: Level II and Level III Order-Level Fields Table 8 Order-Level Fields for FDC Compass CyberSource Field Name FDC Compass Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_ amount Alternate Tax Total amount of alternate tax for the order. Level III Decimal (10) alternate_tax_id Alternate Tax ID Your tax ID number to use for the alternate tax amount. Required if you set Alternate Tax Amount to any value, including zero. You may send this field without sending Alternate Tax Amount. Level III amexdata_taa1 TAA1 Level II amexdata_taa2 TAA2 amexdata_taa3 TAA3 amexdata_taa4 TAA4 Four Transaction Advice Addendum fields. These fields are used to display descriptive information about a transaction on your customer’s American Express card statement. If you are sending any TAA fields, start with amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be ignored. Mastercard (O) String (15) Mastercard (See description) String (40) American Express (See description) Contact CyberSource Customer Support if you plan to use these fields so that your account can be configured appropriately. The amexdata_taa1 field is required for Level II transactions for American Express cards for FDC Compass, but the other TAA fields are optional. However, if you are including the request ID (bill_ request_id) in a Level II credit request, you are not required to include amexdata_taa1. duty_amount freight_amount grand_total_ amount Duty Amount Freight Amount No corresponding FDC Compass field Total charges for any import or export duties included in the order. Level III Visa (O) Mastercard (O) Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include grand_total_amount. Level III Grand total for the entire capture or credit request. Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (O) Mastercard (O) Visa (R) Mastercard (R) Visa: Decimal (13) Mastercard: Decimal (10) Visa: Decimal (13) Mastercard: Decimal (10) Decimal (15) 49 Chapter 5 Table 8 FDC Compass: Level II and Level III Order-Level Fields for FDC Compass (Continued) CyberSource Field Name FDC Compass Field Name Description Used By (Required/ Optional) Data Type & Length order_discount_ amount Discount Amount Applied to Order Total discount applied to the order. For example: a 20.00 discount off the order total. Level III Decimal (13) purchasing_level No corresponding FDC Compass field Flag that indicates the capture or credit request includes Level III data. Set the value for this field to 3. See "Requesting Captures and Credits with Level III Data," page 15. Ship From ZIP/ Postal 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. ship_from_zip Visa (O) Level III Visa (R) Mastercard (R) Level III Visa (O) Mastercard (Required for best rate. Do not use all zeros or nines.) If the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] String (1) String (10) 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 ship_to_country Destination Country Code Country of the shipping address. Use the two-character ISO Standard Country Codes. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (Required for best rate) Mastercard (Optional but recommended) String (2) 50 Chapter 5 Table 8 FDC Compass: Level II and Level III Order-Level Fields for FDC Compass (Continued) CyberSource Field Name FDC Compass Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_zip Destination ZIP/Postal Code Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level III String (10) 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] Visa (Required for best rate) Mastercard (Required for best rate. Do not use all zeros or nines.) Example A1B 2C3 This value is the same as the value for ship_from_zip when your customer takes possession of the items at your location. Level II and Level III Processing Using the SCMP API | June 2017 51 Chapter 5 Table 8 FDC Compass: Level II and Level III Order-Level Fields for FDC Compass (Continued) CyberSource Field Name FDC Compass Field Name Description Used By (Required/ Optional) Data Type & Length user_po Customer Reference Number Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. Level II String (25) Visa (Required for purchase/ procurement cards; optional otherwise) Mastercard (Required for purchase/ procurement cards; optional otherwise) American Express (Required for purchase/ procurement cards; optional otherwise) Level III vat_tax_amount vat_tax_rate Visa (Required for purchase/ procurement cards; optional otherwise) Mastercard (Required for purchase/ procurement cards; optional otherwise) VAT/Tax Amount Total amount of VAT or other tax included in the order. Level III VAT/Tax Rate Rate of VAT or other tax for the order. Level III Example 0.040 (=4%) Decimal (13) Visa (O) Decimal (4) Visa (O) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) Level II and Level III Processing Using the SCMP API | June 2017 52 Chapter 5 FDC Compass: Level II and Level III Offer-Level Fields Important Table 9 The maximum number of offer lines you can have in a Level III FDC Compass transaction is 98. If the number of offer lines exceeds 98, FDC Compass rejects the batch. Offer-Level Fields for FDC Compass CyberSource Field Name FDC Compass Field Name Description Used By (Required/ Optional) Data Type & Length amount Unit Cost Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Level II Decimal (13) Important For a Level III Level III transaction, this value cannot be zero (0). commodity_code discount_amount Visa (R) Mastercard (R) American Express (R) Visa (R) Mastercard (R) Item Commodity Code Commodity code used to classify the item. Level III Visa: Discount Amount for Line Item Discount applied to the item. Level III Mastercard: Discount Amount discount_indicator Discount Indicator Flag that indicates whether the amount is discounted. Possible values: Y: amount is discounted N: amount is not discounted Visa (R) Visa (O) Mastercard (O) Level III String (12) Visa: Decimal (13) Mastercard: Decimal (10) String (1) Mastercard (O) If you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets this field to Y. Level II and Level III Processing Using the SCMP API | June 2017 53 Chapter 5 Table 9 FDC Compass: Level II and Level III Offer-Level Fields for FDC Compass (Continued) CyberSource Field Name FDC Compass Field Name Description Used By (Required/ Optional) Data Type & Length gross_net_indicator Gross/Net Indicator Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: Level III String (1) invoice_number product_code No corresponding FDC Compass field Product Code Y: item amount includes tax amount N: item amount does not include tax amount Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is default. See Appendix B, "Product Codes," on page 134 for a list of valid values. Mastercard (R) Level II Visa (O) Mastercard (O) American Express (O) String (23) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (Required for best rate. Do not use all zeros or spaces.) String (12) For ics_auth, when you set this field to a value other than default or any of the values related to shipping and handling, the quantity, product_name, and merchant_product_sku fields are required. product_name Description Text description of the item. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (R. Do not use all zeros or spaces.) Visa: String (26) Mastercard: String (35) 54 Chapter 5 Table 9 FDC Compass: Level II and Level III Offer-Level Fields for FDC Compass (Continued) CyberSource Field Name FDC Compass Field Name Description Used By (Required/ Optional) Data Type & Length quantity Quantity Number of units of the item purchased. Must be a whole number. If you do not provide this value, CyberSource sets it to 1. Level III Visa: Integer (12) tax_amount Tax Amount Total tax to apply to the product. This value cannot be negative. The tax_amount field is additive. For example, if you include the following offer lines: offer0=amount:10.00^ quantity:1^tax_amount: 0.80 offer1=amount:20.00^ quantity:1^tax_amount: 1.60 Visa (Required for best rate) Mastercard (Required for best rate. Do not use all zeros or spaces.) Level II Visa (R) Mastercard (R) American Express (R) Mastercard: Integer (5) Visa: Decimal (13) Mastercard: Decimal (10) Level III Visa (R) Mastercard (R) the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included. The tax_amount and the amount must be in the same currency. If you want to include tax_ amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. tax_rate Tax Rate Tax rate applied to the item. Level III Visa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). Visa (O) Mastercard (R) Visa: Decimal (4) Mastercard: Decimal (7) Mastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). tax_type_applied Tax Type Applied Type of tax being applied to the item. Level II and Level III Processing Using the SCMP API | June 2017 Level III (O) String (4) Mastercard 55 Chapter 5 Table 9 FDC Compass: Level II and Level III Offer-Level Fields for FDC Compass (Continued) CyberSource Field Name FDC Compass Field Name Description Used By (Required/ Optional) Data Type & Length total_amount Line Item Total Total amount for the item. Normally calculated as the unit price x quantity. Level III Visa: Decimal (13) unit_of_measure Unit of Measure Unit of measure, or unit of measure code, for the item. See Appendix A, "Codes for Units of Measurement," on page 127. Level II and Level III Processing Using the SCMP API | June 2017 Visa (R) Mastercard (R. Do not use all zeros or spaces.) Level III Visa (O) Mastercard (R. Do not use all zeros or spaces.) Mastercard: Decimal (10) Visa: String (12) Mastercard: String (3) 56 Important Important Important CHAPTER FDC Nashville Global: Level II and Level III 6 This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. When you send a capture or credit request with Level II and/or Level III data, you must include the required fields for every capture or credit request. For information about the non-Level-II and non-Level-III fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Starting May 1, 2012: Due to the limited functionality of the supplier_order_ reference field, CyberSource recommends that you use the offer-level field product_name instead. Include only one of these fields in a request; including both fields could result in an error. Processor Specification The specification that CyberSource used to implement Level III processing for FDC Nashville Global is the First Data PTS Specification, v2010-2, October 30, 2010. Level II and Level III Processing Using the SCMP API | June 2017 57 Chapter 6 FDC Nashville Global: Level II and Level III Order-Level Fields Table 10 Order-Level Fields for FDC Nashville Global CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_ amount Other Tax Amount Amount of all taxes, excluding the local tax amount (tax_amount) and national tax (national_tax) included in the total tax. Level II Decimal (11) Note Do not confuse this order-level field with the alternate_tax_amount offer-level field. Visa (Required for non-U.S. transactions; otherwise, not used) Mastercard (Required for non-U.S. transactions; otherwise, not used) American Express (Required for non-U.S. transactions; otherwise, not used) Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (Optional for non-U.S. transactions; otherwise, not used) Mastercard (Optional for non-U.S. transactions; otherwise, not used) 58 Chapter 6 Table 10 FDC Nashville Global: Level II and Level III Order-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_ amount_indicator Other Tax Indicator Flag that indicates whether the alternate tax amount (alternate_tax_amount) is included in the request. Possible values: Level II String (1) 0: alternate tax amount is not included in the request. 1: alternate tax amount is included in the request. Mastercard (Required for non-U.S. transactions; otherwise, not used) Level III duty_amount Duty Amount Total charges for any import or export duties included in the order. This value cannot be negative. Mastercard (Optional for non-U.S. transactions; otherwise, not used) Level II Visa (R) Mastercard (O) Decimal (11) Level III freight_amount grand_total_amount order_discount_ amount Visa (O) Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include grand_total_amount. Level III No corresponding FDC Nashville Global field Grand total for the entire capture or credit request. Level III Discount Amount Total discount applied to the order. For example: a 20.00 discount off the order total. This value cannot be negative. Freight Amount Visa (O) Mastercard (O) Visa (R) Mastercard (R) Level II Visa (R) Mastercard (O) Decimal (13) Decimal (15) Decimal (11) Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (O) 59 Chapter 6 Table 10 FDC Nashville Global: Level II and Level III Order-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length purchaser_vat_ registration_number Customer VAT Registration Number Identification number assigned to the purchasing company by the tax authorities. Level II String (13) purchasing_level No corresponding FDC Nashville Global field Flag that indicates the capture or credit request includes Level III data. Set the value for this field to 3. See "Requesting Captures and Credits with Level III Data," page 15. Level III Ship From Zip 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. Level II ship_from_zip If the billing country is the U.S., the 9digit postal code must follow this format: [5 digits][dash][4 digits] Visa (Required for non-U.S. Visa transactions; otherwise, not used) Visa (R) Mastercard (R) Visa (O) Mastercard (O) String (1) String (10) Level III Visa (R) Mastercard (R) Example 12345-6789 If the billing country is Canada, the 6digit postal code must follow this format: [alpha][numeric][alpha] [space][numeric][alpha] [numeric] Example A1B 2C4 Level II and Level III Processing Using the SCMP API | June 2017 60 Chapter 6 Table 10 FDC Nashville Global: Level II and Level III Order-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_country Destination Country Country of the shipping address. Use the two-character ISO Standard Country Codes. Level II String (2) Note If you include the ship_to_ country field in a request and if the ship-to country is the U.S. or Canada, the request must also include the ship_ to_state field. ship_to_state Mastercard (R) Level III Visa (Required if freight_ amount is included; otherwise, recommended for best rate) Mastercard (Optional but recommended) State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. Level II This field must be included in a request if the ship_to_country field is included and the ship-to country is the U.S. or Canada. Level III Level II and Level III Processing Using the SCMP API | June 2017 String (2) Mastercard (R) Visa (See description) Mastercard (See description) 61 Chapter 6 Table 10 FDC Nashville Global: Level II and Level III Order-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_zip Destination Zip Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level II String (10) 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] Visa (R) Mastercard (R) American Express (R) Level III Visa (R) Mastercard (R) Example A1B 2C3 This value is the same as the value for ship_from_zip when your customer takes possession of the items at your location. If the postal code for the shipping address is not included in the request message, CyberSource uses the postal code for the billing address. If the postal code for the billing address is not included in the request message, the postal code for the shipping address is required. supplier_order_ reference Item Description Part A Text description of the item. Level III Important Starting May 1, 2012: Due Visa (R) Mastercard (Required for reduced interchange) to the limited functionality of the supplier_order_reference field, CyberSource recommends that you use the offer-level field product_name instead. Include only one of these fields in a request; including both fields could result in an error. Level II and Level III Processing Using the SCMP API | June 2017 String (25) 62 Chapter 6 Table 10 FDC Nashville Global: Level II and Level III Order-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length user_po Customer Code Value used by your customer to identify the order. This value is typically a purchase order number. You must provide a value in this field or in the merchant_ref_number field. CyberSource recommends that you do not populate the field with all zeros or nines. Level II String (25) Visa (See description) Mastercard (See description) American Express (See description) Level III vat_invoice_ref_ number VAT Invoice Reference Number VAT invoice number associated with the transaction. Level II and Level III Processing Using the SCMP API | June 2017 Visa (See description) Mastercard (See description) Level II String (15) Visa (Required for non-U.S. Visa transactions; otherwise, not used) 63 Chapter 6 Table 10 FDC Nashville Global: Level II and Level III Order-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length vat_tax_ VAT/Tax Amount Total amount of VAT or other tax on freight or shipping only. Level II Decimal (11) vat_tax_rate VAT/Tax Rate Vat tax rate for freight or shipping. Level II and Level III Processing Using the SCMP API | June 2017 Visa (Optional for non-U.S. transactions; otherwise, not used) Mastercard (Optional for non-U.S. transactions; otherwise, not used) American Express (Optional for non-U.S. transactions; otherwise, not used) Level II Visa (Optional for non-U.S. transactions; otherwise, not used) Mastercard (Optional for non-U.S. transactions; otherwise, not used) American Express (Optional for non-U.S. transactions; otherwise, not used) Decimal (5) 64 Chapter 6 FDC Nashville Global: Level II and Level III Offer-Level Fields Table 11 Offer-Level Fields for FDC Nashville Global CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_amount Item Other Tax Amount Visa: VAT or other tax amount. Level III Decimal (13) Mastercard: Tax amount collected for a special type of tax. Visa (O) Mastercard (O) Important For Mastercard, do not set this field to 0 (zero). Note Do not confuse this offer-level field with the alternate_tax_amount order-level field. alternate_tax_id alternate_tax_rate Tax Amount 1 Tax ID Your tax ID number to use for the alternate tax amount. Level III Item Tax Rate Applied Mastercard: Tax rate for a type of tax collected. Level III Visa: VAT or other tax rate. alternate_tax_type_ applied Item Tax Type Applied Mastercard: Flag that defines tax categories for domestic processing in certain locations. Visa: VAT or other tax type. Level II and Level III Processing Using the SCMP API | June 2017 String (15) Mastercard (Required if alternate_tax_ amount is included; otherwise, optional.) Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) String (5) String (4) 65 Chapter 6 Table 11 FDC Nashville Global: Level II and Level III Offer-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_type_ identifier Tax Type Identifier Flag that indicates the type of tax collected for alternate_tax_amount. Possible values: Level III String (2) amount Item Unit Cost 00: unknown 01: federal or national sales tax 02: states sales tax 03: city sales tax 04: local sales tax 05: municipal sales tax 06: other tax 10: value-added tax (VAT) 11: goods and services tax (GST) 12: provincial sales tax 20: room tax 21: occupancy tax 22: energy tax Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Visa (O) Mastercard (O) Level II Visa (R) Mastercard (R) American Express (R) Decimal (13) Important For a Level III transaction, this value cannot be zero (0). Important For Mastercard, this value cannot be zero (0). commodity_code discount_amount Item Commodity Code Item Discount Amount Level III Visa (R) Mastercard (R) International description code used to classify the item. Contact your acquirer or FDC Nashville Global for a list of codes. Level III Discount applied to the item. Level III Important For Mastercard, do not set Visa (O) Mastercard (O) this field to 0 (zero). Level II and Level III Processing Using the SCMP API | June 2017 Visa (R) Mastercard (O) String (12) Decimal (13) 66 Chapter 6 Table 11 FDC Nashville Global: Level II and Level III Offer-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length invoice_number No corresponding FDC Nashville Global field You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Level II String (23) Visa (O) Mastercard (O) American Express (O) Level III local_tax Item Local Tax Amount national_tax Item Customer Code National Tax Amount Visa (O) Mastercard (O) Sales tax applied to the item. Level III Important For Mastercard, do not set Visa (O) Mastercard (O) this field to 0 (zero). merchant_product_sku Identification code for the product. For ics_auth and ics_bill, this field is required when product_code is not default or one of the values related to shipping and/or handling. Amount of national tax or value added tax for countries in which more than one tax is applied. Provide this value if national_tax differs from tax_amount. If you do not provide this value, CyberSource assumes that national_ tax is equal to tax_amount. Level III Visa (See description) Mastercard (See description) Level II Decimal (13) String (30) Decimal (11) Visa (Required for non-U.S. transactions; otherwise, not used) Important For Mastercard, do not set this field to 0 (zero). product_code Item Product Code Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is default. See Appendix B, "Product Codes," on page 134 for a list of valid values. Level III Visa (R) Mastercard (Required for reduced interchange) String (12) For ics_auth, when you set this field to a value other than default or any of the values related to shipping and handling, the quantity, product_name, and merchant_product_sku fields are required. Level II and Level III Processing Using the SCMP API | June 2017 67 Chapter 6 Table 11 FDC Nashville Global: Level II and Level III Offer-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length product_name Description Text description of the item. Level III Visa: String (26) quantity tax_amount Item Quantity Local Tax Amount Number of units of the item purchased. Must be a whole number. If you do not provide this value, CyberSource uses 1. Visa (O) Mastercard (R. Do not use all zeros or spaces.) Level III Visa (R) Mastercard (Required for reduced interchange) Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. Level II The tax amount field is additive. The following example uses a two-exponent currency such as USD: Visa (R) Mastercard (R) American Express (R) Mastercard: String (35) Integer (12) Visa & Mastercard: Decimal (11) American Express: Decimal (9) 1 You include the following offer lines in your request: offer0=amount:10.00^quan tity:1^tax_amount:0.80 offer1=amount:20.00^quan tity:1^tax_amount:1.60 2 The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. If you want to include tax_amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. Note This value is the sales tax. For Visa transactions, this value must be between 0.1% and 22% of the total sale. Note For Visa and American Express, if this value is 0 (zero), the order is tax exempt. Important For Mastercard, do not set this field to 0 (zero). Level II and Level III Processing Using the SCMP API | June 2017 68 Chapter 6 Table 11 FDC Nashville Global: Level II and Level III Offer-Level Fields for FDC Nashville Global (Continued) CyberSource Field Name FDC Nashville Global Field Name Description Used By (Required/ Optional) Data Type & Length unit_of_measure Item Bulk/Unit of Measure Unit of measure, or unit of measure code, for the item. See Appendix A, "Codes for Units of Measurement," on page 127. Level III String (12) Level II and Level III Processing Using the SCMP API | June 2017 Visa (R) Mastercard (Required for reduced interchange) 69 Important Important CHAPTER FDMS Nashville: Level II 7 This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. When you send a capture or credit request with Level II data, you must include the required fields for every capture or credit request. For information about the non-Level-II fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Level II and Level III Processing Using the SCMP API | June 2017 70 Chapter 7 FDMS Nashville: Level II Order-Level Fields Table 12 Order-Level Fields for FDMS Nashville CyberSource Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_zip Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level II String (10) When the shipping country is the U.S., the 9digit postal code must follow this format: [5 digits][dash][4 digits] Visa Mastercard Example 12345-6789 When the shipping country is Canada, the 6digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example A1B 2C3 If the postal code for the shipping address is not included in the request message, CyberSource uses the postal code for the billing address. If the postal code for the billing address is not included in the request message, the postal code for the shipping address is required. tax_indicator user_po Flag that indicates whether an order is taxable. Possible values: Y: the order is taxable. N: the order is not taxable. Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. Level II and Level III Processing Using the SCMP API | June 2017 Level II Visa Mastercard Level II Visa (Required for purchase/ procurement cards; optional otherwise) Mastercard (Required for purchase/ procurement cards; optional otherwise) String (1) String (25) 71 Chapter 7 FDMS Nashville: Level II Offer-Level Fields Table 13 Offer-Level Fields for FDMS Nashville CyberSource Field Name Description Used By (Required/ Optional) Data Type & Length amount Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Level II Decimal (15) invoice_number tax_amount Visa (R) Mastercard (R) Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Level II Total tax to apply to the product. This value cannot be negative. The tax_amount field is additive. For example, if you include the following offer lines: Level II Visa (O) Mastercard (O) Visa (R) Mastercard (R) String (23) Decimal (15) offer0=amount:10.00^ quantity:1^tax_amount: 0.80 offer1=amount:20.00^ quantity:1^tax_amount: 1.60 the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included. The tax_ amount and the amount must be in the same currency. If you want to include tax_amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. Level II and Level III Processing Using the SCMP API | June 2017 72 CHAPTER FDMS South: Level II Important Important 8 This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. When you send a capture or credit request with Level II data, you must include the required fields for every capture or credit request. For information about the non-Level-II fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Order-Level Fields Table 14 Order-Level Fields for FDMS South CyberSource Field Name Description Used By (Required/ Optional) Data Type & Length duty_amount Total charges for any import or export duties included in the order. This value cannot be negative. Level II Decimal (15) purchaser_code purchaser_vat_ registration_number Customer ID reference number that identifies the customer for a Level II transaction. Identification number assigned to the purchasing company by the tax authorities. Level II and Level III Processing Using the SCMP API | June 2017 Mastercard Level II Visa (Required for purchase/ procurement cards; optional otherwise) Level II String (17) String (13) Visa 73 Chapter 8 Table 14 FDMS South: Level II Order-Level Fields for FDMS South (Continued) CyberSource Field Name Description Used By (Required/ Optional) Data Type & Length ship_from_zip 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. Level II String (10) Mastercard 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 ship_to_country ship_to_zip Country of the shipping address. Use the two-character ISO Standard Country Codes. Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level II Mastercard Level II When the shipping country is the U.S., the 9digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 String (2) String (10) Mastercard (Required for purchase/ procurement cards; otherwise, optional) When the shipping country is Canada, the 6digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example A1B 2C3 If the postal code for the shipping address is not included in the request message, CyberSource uses the postal code for the billing address. If the postal code for the billing address is not included in the request message, the postal code for the shipping address is required. summary_commodity_ code Categorizes purchases for VAT reporting. Level II and Level III Processing Using the SCMP API | June 2017 Level II String (4) Visa 74 Chapter 8 Table 14 FDMS South: Level II Order-Level Fields for FDMS South (Continued) CyberSource Field Name Description Used By (Required/ Optional) Data Type & Length tax_indicator Flag that indicates whether an order is taxable. Possible values: Level II String (1) user_po Y: the order is taxable. N: the order is not taxable. Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. Visa Mastercard Level II Visa (Required for purchase/ procurement cards; optional otherwise) Mastercard (Required for purchase/ procurement cards; optional otherwise) String (25) Offer-Level Fields Table 15 Offer-Level Fields for FDMS South CyberSource Field Name Description Used By (Required/ Optional) Data Type & Length amount Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Level II Decimal (15) invoice_number national_tax Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Amount of national tax or value added tax for countries in which more than one tax is applied. Provide this value if national_tax differs from tax_amount. If you do not provide this value, CyberSource assumes that national_tax is equal to tax_amount. Level II and Level III Processing Using the SCMP API | June 2017 Visa (R) Mastercard (R) Level II Visa (O) Mastercard (O) Level II Visa Mastercard String (23) Decimal (15) 75 Chapter 8 Table 15 FDMS South: Level II Offer-Level Fields for FDMS South (Continued) CyberSource Field Name Description Used By (Required/ Optional) Data Type & Length tax_amount Total tax to apply to the product. This value cannot be negative. The tax_amount field is additive. For example, if you include the following offer lines: Level II Decimal (15) Visa (R) Mastercard (R) offer0=amount:10.00^quantity:1 ^tax_amount:0.80 offer1=amount:20.00^quantity:1 ^tax_amount:1.60 the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included. The tax_ amount and the amount must be in the same currency. If you want to include tax_amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. vat_rate Rate used to calculate VAT. If you do not provide this value, CyberSource calculates the rate as (national_tax x 100 / amount). Level II and Level III Processing Using the SCMP API | June 2017 Level II Visa Mastercard Decimal (5) 76 Important Important CHAPTER GPN: Level II and Level III 9 This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. When you send a capture or credit request with Level II and/or Level III data, you must include the required fields for every capture or credit request. For information about the non-Level-II and non-Level-III fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Processor Specification The specification that CyberSource used to implement Level II and Level III processing for GPN is the Global Payments Big Batch Message Specification, Version 2006.001, January 2006. Level II and Level III Processing Using the SCMP API | June 2017 77 Chapter 9 GPN: Level II and Level III Order-Level Fields Table 16 Order-Level Fields for GPN CyberSource Field Name GPN Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_ amount Other Tax Total amount of alternate tax for the order. Maximum amount is 99,999.99. Level III Decimal (12) duty_amount Duty Amount freight_amount merchant_vat_ registration_ number national_tax order_discount_ amount purchaser_order_ date purchaser_vat_ registration_ number purchasing_level Freight Amount Merchant VAT Number National Tax Discount Amount Order Date Customer VAT Number No corresponding GPN field Total charges for any import or export duties included in the order. Maximum amount is 99,999.99. Total freight or shipping and handling charges for the order. Maximum amount is 99,999.99. When you include this field in your request, you must also include grand_total_amount. Your government-assigned tax identification number. National tax for the order. Maximum amount is 99,999.99. Total discount applied to the order. For example: a 20.00 discount off the order total. Maximum amount is 99,999.99. Date the order was processed. Format: YYMMDD. Customer’s government-assigned tax identification number. Flag that indicates the capture or credit request includes Level III data. Set the value for this field to 3. See "Requesting Captures and Credits with Level III Data," page 15. Level II and Level III Processing Using the SCMP API | June 2017 Visa (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Level III Decimal (12) Decimal (12) String (20) Decimal (12) Visa (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Decimal (12) Decimal (6) Visa: String (15) Mastercard: String (20) String (1) 78 Chapter 9 Table 16 GPN: Level II and Level III Order-Level Fields for GPN (Continued) CyberSource Field Name GPN Field Name Description Used By (Required/ Optional) Data Type & Length ship_from_zip 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. Level III String (10) Visa (O) Mastercard (O) If the billing country is the U.S., the 9digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 If the billing country is Canada, the 6digit postal code must follow this format: [alpha][numeric][alpha] [space][numeric][alpha] [numeric] Example A1B 2C4 ship_to_country ship_to_state Destination Country Code Destination State/Province Code Country of the shipping address. Use the two-character ISO Standard Country Codes. State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) String (2) String (2) 79 Chapter 9 Table 16 GPN: Level II and Level III Order-Level Fields for GPN (Continued) CyberSource Field Name GPN Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_zip Destination Postal/Zip Code Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level III String (10) When the shipping country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Visa (O) Mastercard (O) 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 ship_from_zip when your customer takes possession of the items at your location. summary_ commodity_code supplier_order_ reference user_po Level III Summary Commodity Code and Commodity Code International description code of the overall order’s goods or services. Contact your acquirer or GPN for a list of codes. Visa (O) Mastercard (O) Item Description Text description of the item. Level III Market Data “m” Customer Code and Reference Number Value used by your customer to identify the order. This value is typically a purchase order number. Visa (O) Mastercard (O) Level II Visa (R) Mastercard (R) String (4) String (25) Visa: String (17) Mastercard: String (25) Level III vat_tax_amount VAT/Tax Amount (Freight/ Shipping) Tax amount applied to freight / shipping costs. Level II and Level III Processing Using the SCMP API | June 2017 Visa (R) Mastercard (R) Level III Decimal (12) Visa (O) 80 Chapter 9 Table 16 GPN: Level II and Level III Order-Level Fields for GPN (Continued) CyberSource Field Name GPN Field Name Description Used By (Required/ Optional) Data Type & Length vat_tax_rate VAT/Tax Rate (Freight/ Shipping) Tax rate applied to freight / shipping costs. Level III Decimal (4) Visa (O) Example 0.040 (=4%) Offer-Level Fields Table 17 Offer-Level Fields for GPN CyberSource Field Name GPN Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_rate Tax Rate N Tax rate applied to the item. Level III Decimal (5) amount Unit Price Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Maximum amount is 99,999.99. Visa (O) Mastercard (O) Level II Visa (O) Mastercard (O) Level III Visa (Required for Level III interchange) Mastercard (Required for Level III interchange) Important For a Level III transaction, this value cannot be zero (0). Note For each offer line that you include in a request, you must include an amount field. commodity_code Item Commodity Code International description code used to classify the item. Contact your acquirer or GPN for a list of codes. Level III Level II and Level III Processing Using the SCMP API | June 2017 Decimal (10) Visa (Required for Level III interchange) Visa: String (12) Mastercard: String (15) Mastercard (Required for Level III interchange) 81 Chapter 9 Table 17 GPN: Level II and Level III Offer-Level Fields for GPN (Continued) CyberSource Field Name GPN Field Name Description Used By (Required/ Optional) Data Type & Length discount_amount Item Discount Discount applied to the item. Maximum amount is 99,999.99. Level III Decimal (12) discount_rate invoice_number product_code Visa (Required for Level III interchange) Mastercard (Required for Level III interchange) Item Discount Rate Rate the item is discounted. Level III Example 5.25 (=5.25%) No corresponding GPN field Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Level II Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is default. See Appendix B, "Product Codes," on page 134 for a list of valid values. Level III Product Code For ics_auth, when you set this field to a value other than default or any of the values related to shipping and handling, the quantity, product_name, and merchant_product_sku fields are required. Level II and Level III Processing Using the SCMP API | June 2017 Mastercard (Required for Level III interchange) Visa (O) Mastercard (O) Decimal (5) Visa (Required for Level III interchange) String (23) Visa: String (12) Mastercard: String (15) Mastercard (Required for Level III interchange) 82 Chapter 9 Table 17 GPN: Level II and Level III Offer-Level Fields for GPN (Continued) CyberSource Field Name GPN Field Name Description Used By (Required/ Optional) Data Type & Length quantity Item Quantity Number of units of the item purchased. Must be a whole number. If you do not provide this value, CyberSource uses 1. Level III Integer (12) tax_amount Level II: Amount 2 Level III: Tax Amount N Total tax to apply to the product. This value cannot be negative. The tax_amount field is additive. For example, if you include the following offer lines: offer0=:amount10.00^ quantity:1^tax_amount: 0.80 offer1=amount:20.00^ quantity:1^tax_amount: 1.60 Visa (Required for Level III interchange) Mastercard (Required for Level III interchange) Level II Visa (O) Mastercard (O) Level II: Decimal (10) Level III: Decimal (12) Level III Visa (O) Mastercard (O) the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included. The tax_amount and the amount must be in the same currency. Maximum amount is 99,999.99. For Level II, if you do not include this field in your request, CyberSource sets this field to the default value of 0. For Level II, this value is the sales tax. For Visa Level II transactions, this value must be zero or must be between 0.1% and 22% of the total sale. If you want to include tax_ amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. Level II and Level III Processing Using the SCMP API | June 2017 83 Chapter 9 Table 17 GPN: Level II and Level III Offer-Level Fields for GPN (Continued) CyberSource Field Name GPN Field Name Description Used By (Required/ Optional) Data Type & Length unit_of_measure Unit of Measure Unit of measure for the item. Level III String (12) Level II and Level III Processing Using the SCMP API | June 2017 Visa (Required for Level III interchange) Mastercard (Required for Level III interchange) 84 Important CHAPTER Litle: Level II and Level III 10 This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. To qualify for Level III interchange rates for Visa and Mastercard, you need to include at least one offer in your request. Important Important When you send a capture or credit request with Level II and/or Level III data, you must include the required fields for every capture or credit request. For information about the non-Level-II and non-Level-III fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Level II and Level III Processing Using the SCMP API | June 2017 85 Chapter 10 Litle: Level II and Level III Order-Level Fields Table 18 Order-Level Fields for Litle CyberSource Field Name Litle Field Name Description Used By (Required/ Optional) Data Type & Length amexdata_taa1 item Description Four Transaction Advice Addendum fields. These fields are used to display descriptive information about a transaction on your customer’s American Express card statement. If you are sending any TAA fields, start with amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be ignored. Level II String (26) amexdata_taa2 amexdata_taa3 amexdata_taa4 American Express (R) Contact CyberSource Customer Support if you plan to use these fields so that your account can be configured appropriately. If you request a follow-on credit for an American Express Level II capture that included TAA data and if the TAA data is not included in the follow-on credit request, CyberSource uses the TAA data from the capture request. duty_amount freight_amount merchant_vat_ registration_number order_discount_ amount purchaser_order_ date dutyAmount shipping Amount cardAcceptor TaxId discount Amount orderDate Total charges for any import or export duties included in the order. Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include grand_total_amount. Your government-assigned tax identification number. Level III Visa (R) Mastercard (O) Level III Visa (R) Mastercard (O) Level III Visa (Not used) For Visa, Litle uses the value in your Litle account. Mastercard (O) Total discount applied to the order. Level III Date the order was processed. If this value is not included in the request, CyberSource uses today’s date. Format: YYYY-MM-DD. Level II and Level III Processing Using the SCMP API | June 2017 Visa (R) Mastercard (O) Level III Visa (O) Mastercard (O) Decimal (8) Decimal (8) String (20) Decimal (8) String (10) 86 Chapter 10 Table 18 Litle: Level II and Level III Order-Level Fields for Litle (Continued) CyberSource Field Name Litle Field Name Description Used By (Required/ Optional) Data Type & Length purchasing_level No corresponding Litle field Flag that indicates the capture or credit request includes Level III data. Set the value for this field to 3. See "Requesting Captures and Credits with Level III Data," page 15. Level III String (1) 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. CyberSource recommends that this value not exceed 10 characters. Level III ship_from_zip shipFrom PostalCode Visa (R) Mastercard (R) Visa (O) Mastercard (O) String (20) If the billing country is the U.S., the 9digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 If the billing country is Canada, the 6digit postal code must follow this format: [alpha][numeric][alpha] [space][numeric][alpha] [numeric] Example A1B 2C4 ship_to_country destination CountryCode Country of the shipping address. Use the two-character ISO Standard Country Codes. If this value is not included in the request, CyberSource uses the bill_ country value from the authorization request. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) String (3) 87 Chapter 10 Table 18 Litle: Level II and Level III Order-Level Fields for Litle (Continued) CyberSource Field Name Litle Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_zip destination PostalCode Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level III String (20) When the shipping country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Visa (O) Mastercard (O) 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 ship_from_zip when your customer takes possession of the items at your location. CyberSource recommends that this value not exceed 10 characters. If this value is not included in the request, CyberSource uses the bill_zip value from the authorization request. tax_indicator taxExempt Flag that indicates whether the order is taxable. Level II Visa (See description) This value is: Required if the sum of all tax_ amount values = 0. Mastercard (See description) Optional if the sum of all tax_ amount values > 0. American Express (See description) Possible values: Y: the order is taxable. N: the order is not taxable. Level II and Level III Processing Using the SCMP API | June 2017 String (1) Level III Visa (See description) Mastercard (See description) 88 Chapter 10 Table 18 Litle: Level II and Level III Order-Level Fields for Litle (Continued) CyberSource Field Name Litle Field Name Description Used By (Required/ Optional) Data Type & Length user_po customer Reference Value used by your customer to identify the order. This value is typically a purchase order number. Level II String (17) Visa (R) Mastercard (R) American Express (R) Level III vat_invoice_ref_ number invoice Reference Number Invoice number associated with the transaction. Visa (R) Mastercard (O) Level III Visa (O) Mastercard (O) String (15) Offer-Level Fields The maximum number of offers that you can include in a request is: Table 19 American Express Level II: 4 offers Mastercard Level III: 99 offers Visa Level III: 99 offers Offer-Level Fields for Litle CyberSource Field Name Litle Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_amount taxAmount Amount collected for a special type of tax. Level III Decimal (8) alternate_tax_id alternate_tax_rate cardAcceptor TaxId taxRate Your tax ID number to use for the alternate tax amount. Tax rate for the special tax. Level II and Level III Processing Using the SCMP API | June 2017 Visa (Not used) Mastercard (O) Level III Visa (Not used) Mastercard (O) Level III Visa (Not used) Mastercard (O) String (20) Decimal (5) 89 Chapter 10 Table 19 Litle: Level II and Level III Offer-Level Fields for Litle (Continued) CyberSource Field Name Litle Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_type_ identifier taxType Identifier Flag that indicates the type of tax collected for alternate_tax_ amount. Possible values: Level III String (2) 00: unknown 01: federal or national sales Visa (Not used) Mastercard (O) tax 02: states sales tax 03: city sales tax 04: local sales tax 05: municipal sales tax 06: Other tax 10: value-added tax (VAT) 11: goods and services tax (GST) amount unitCost 12: provincial sales tax 13: harmonized sales tax 14: Quebec sales tax 20: room tax 21: occupancy tax 22: energy tax Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Level III Visa (R) Mastercard (O) Decimal (12) Important For a Level III transaction, this value cannot be zero (0). commodity_code discount_amount commodity Code itemDiscount Amount International description code used to classify the item. Contact your acquirer for a list of codes. Discount applied to the item. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (R) Mastercard (O) Level III Visa (R) Mastercard (O) String (12) Decimal (8) 90 Chapter 10 Table 19 Litle: Level II and Level III Offer-Level Fields for Litle (Continued) CyberSource Field Name Litle Field Name Description Used By (Required/ Optional) Data Type & Length invoice_number No corresponding Litle field Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Level III String (23) Product code for the item. In the United States, this may be a UPC code, part number, or product number. Level III Text description of the item. Level III product_code product_name quantity productCode item Description quantity Number of units of the item purchased. Must be a whole number. Level II and Level III Processing Using the SCMP API | June 2017 Visa (O) Mastercard (O) Visa (R) Mastercard (R) Visa (R) Mastercard (R) Level III Visa (R) Mastercard (R) String (12) String (26) Decimal (9) 91 Chapter 10 Table 19 Litle: Level II and Level III Offer-Level Fields for Litle (Continued) CyberSource Field Name Litle Field Name Description Used By (Required/ Optional) Data Type & Length tax_amount taxAmount Total tax to apply to the product. This value cannot be negative. The tax_amount field is additive. For example, if you include the following offer lines: Level II Decimal (8) Visa (Required for the best rate for corporate cards; required if tax_indicator = Y; otherwise, optional.) Mastercard (Required for the best rate for corporate cards; required if tax_ indicator = Y; otherwise, optional.) American Express (Required for the best rate for corporate cards; required if tax_ indicator = Y; otherwise, optional.) offer0=amount:10.00^ quantity:1^tax_amount: 0.80 offer1=amount:20.00^ quantity:1^tax_amount: 1.60 the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included. The tax_amount and the amount must be in the same currency. For Level II, if you do not include this field in your request, CyberSource sets this field to the default value of 0. If you want to include tax_ amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (Required for the best rate for corporate cards; required if tax_indicator = Y; otherwise, optional.) Mastercard (Required for the best rate for corporate cards; required if tax_ indicator = Y; otherwise, optional.) 92 Chapter 10 Table 19 Litle: Level II and Level III Offer-Level Fields for Litle (Continued) CyberSource Field Name Litle Field Name Description Used By (Required/ Optional) Data Type & Length total_amount lineItemTotal Total purchase amount for the item. Normally calculated as the unit price x quantity. Level III Decimal (8) unit_of_measure unitOfMeasure Unit of measure, or unit of measure code, for the item. See Appendix A, "Codes for Units of Measurement," on page 127. Level II and Level III Processing Using the SCMP API | June 2017 Visa (R) Mastercard (R) Level III Visa (R) Mastercard (R) String (12) 93 Important Note Important CHAPTER OmniPay Direct: Level II and Level III 11 This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. On OmniPay Direct, the acquirers that support Level II and Level III data are Bank of America Merchant Services and First Data Merchant Solutions (Europe). When you send a capture request with Level II and/or Level III data, you must include the required fields for every capture request. For information about the non-Level-II and non-Level-III fields required for capture requests, see Credit Card Services Using the SCMP API. Processor Specification The specification that CyberSource used to implement Level II and Level III processing for OmniPay Direct is OmniPay 80Byte Electronic File Specifications, version 4.9, September 2015. Level II and Level III Processing Using the SCMP API | June 2017 94 Chapter 11 OmniPay Direct: Level II and Level III Order-Level Fields Table 20 Order-Level Fields for OmniPay Direct CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length duty_amount Duty Amount Total charges for any import or export duties included in the order. Level II Decimal (12) Visa (O) Level III freight_amount grand_total_amount Freight Amount / Shipping Amount Line Item Total Total freight or shipping and handling charges for the order. For a Level II transaction with Visa, CyberSource sets the value for this field to zero (0) when you do not include it in the request. Grand total for the entire request. Visa (O) Mastercard (O) Level III Visa (R for interchange rates) Mastercard (O) Level II local_tax_indicator Local Tax Included 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 Level II and Level III Processing Using the SCMP API | June 2017 Decimal (12) Visa (R for interchange rates) Level III Decimal (12) String (1) Visa (O) 95 Chapter 11 Table 20 OmniPay Direct: Level II and Level III Order-Level Fields for OmniPay Direct (Continued) CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length merchant_vat_ registration_number Merchant VAT Registration / Single Business Reference Number / Merchant Tax ID / Corporation VAT Number Your government-assigned tax identification number. Level II String (21) national_tax National Tax Visa (R for interchange rates) Mastercard (R for interchange rates) Level III Visa (R for interchange rates) Mastercard (R for interchange rates) National tax for the order. Level II When you include this field in the request, you must also include the tax_ amount field in the request. String (12) Visa (R for interchange rates) Level III national_tax_ indicator National Tax Included Flag that indicates whether a national tax is included in the order total. Possible values: 0: national tax not included 1: national tax included Visa (R for interchange rates) Level II String (1) Visa (R for interchange rates) Level III order_discount_ amount Discount Amount / Total Discount Total discount applied to the order. Level II and Level III Processing Using the SCMP API | June 2017 Visa (R for interchange rates) Level III Visa (R for interchange rages) Mastercard (R) Decimal (12) 96 Chapter 11 Table 20 OmniPay Direct: Level II and Level III Order-Level Fields for OmniPay Direct (Continued) CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length purchaser_order_ date Order Date Date the order was processed. Format: YYMMDD. Level II String (6) Visa (O) Level III purchaser_vat_ registration_number Customer VAT Registration Number Customer’s government-assigned tax identification number. Visa (O) Level II String (13) Visa (O) Level III purchasing_level ship_from_zip Visa (O) No corresponding OmniPay Direct field Flag that indicates the capture request includes Level III data. Set the value for this field to 3. See "Requesting Captures and Credits with Level III Data," page 15. Level III 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. Level III Visa (R) Mastercard (R) Visa (O) Mastercard (O) String (1) String (10) When the goods ship from the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the goods ships from Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example A1B 2C3 ship_to_country Destination Country Code Country of the shipping address. Use the two-character ISO Standard Country Codes. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (O) Mastercard (O) String (3) 97 Chapter 11 Table 20 OmniPay Direct: Level II and Level III Order-Level Fields for OmniPay Direct (Continued) CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_zip Destination Postal / ZIP Code Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level II String (10) 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 Visa (O) Level III Visa (O) Mastercard (O) 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 the shipFrom_postalCode field when your customer takes possession of the items at your location. The postal code must consist of 5 to 9 digits. summary_ commodity_code Summary Commodity Code International description code of the overall order’s goods or services. Contact your acquirer for a list of codes. Level II String (4) Visa (R for interchange rates) Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (R for interchange rates) 98 Chapter 11 Table 20 OmniPay Direct: Level II and Level III Order-Level Fields for OmniPay Direct (Continued) CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length supplier_order_ reference Purchase Identifier / Merchant Related Data / Merchant Reference Number Text description of the item. Level II Visa: String (25) Visa (R for interchange rates) Mastercard: String (17) Mastercard (R for interchange rates) Level III tax_indicator total_tax_amount Detail Tax Amount Indicator Tax Amount / Total Tax Amount Flag that indicates whether tax is included in the total purchase amount. Possible values: Y: tax is included in total purchase amount and tax is sum of values for all tax_amount fields. N: tax is not included in total purchase amount. Total tax amount for all the items in the order. Visa (R for interchange rates) Mastercard (R for interchange rates) Level III String (1) Mastercard (O) Level II Visa (O) Mastercard (R for interchange rates) Decimal (12) Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (O) Mastercard (R for interchange rates) 99 Chapter 11 Table 20 OmniPay Direct: Level II and Level III Order-Level Fields for OmniPay Direct (Continued) CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length user_po Customer Code / Customer Reference ID Value used by your customer to identify the order. This value is typically a purchase order number. Level II String (25) Visa (R) Mastercard (R) Level III vat_tax_amount VAT (Amount) vat_tax_rate VAT (Rate) Visa (R for interchange rates) Mastercard (R for interchange rates) Total amount of VAT or other tax included in the order. Level III Rate of VAT or other tax for the order. Level III Example 0.04 (=4%) Valid range: 0.01 to 0.99 (1% to 99%) Decimal (12) Visa (O) Decimal (4) Visa (R for interchange rages) Offer-Level Fields Table 21 Offer-Level Fields for OmniPay Direct CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_amount VAT / Tax Amount (Freight or Shipping) Tax amount on shipping/freight. Level II Decimal (12) Visa (O) Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (O) 100 Chapter 11 Table 21 OmniPay Direct: Level II and Level III Offer-Level Fields for OmniPay Direct (Continued) CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_rate VAT / Tax Rate (Freight or Shipping) Rate used to generate the value for the alternate_tax_amount field. Level II String (4) When you include the alternate_ tax_amount and national_tax fields and do not include the alternate_tax_rate field, CyberSource calculates the rate as national_tax x 100 / amount. amount Unit Cost / Unit Price Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Visa (R for interchange rates) Level III Visa (R for interchange rates) Level III Visa (R for interchange rates) Mastercard (R for interchange rates) Decimal (12) Important For a Level III transaction, this value cannot be zero (0). commodity_code Item Commodity Code International description code used to classify the item. Contact your acquirer for a list of codes. Level II Visa (R for interchange rates) Visa: String (12) Mastercard: String (4) Mastercard (O) Level III discount_amount Discount Per Line Item / Discount Amount Discount applied to the item. Level II and Level III Processing Using the SCMP API | June 2017 Visa (O) Mastercard (O) Level III Visa (R for interchange rates) Mastercard (R for interchange rates) String (12) 101 Chapter 11 Table 21 OmniPay Direct: Level II and Level III Offer-Level Fields for OmniPay Direct (Continued) CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length discount_indicator Discount Indicator Flag that indicates whether the amount is discounted. Possible values: Level III String (1) discount_rate Item Discount Rate Y: amount is discounted N: amount is not discounted Rate at which the item is discounted. Mastercard (O) Level III String (5) Mastercard (O) Example 0.050 (=5%) Valid range: 0.010 to 0.999 (1% to 99.9%) product_code Product Code Type of product. This value is used to determine the product category: electronic, handling, physical, service, or shipping. The default value is default. See Appendix B, "Product Codes," on page 134 for a list of valid values. For ics_auth, when you set this field to a value other than default or any of the values related to shipping and handling, the quantity, product_name, and merchant_product_sku fields are required. product_name quantity Item Description Quantity / Item Quantity Text description of the item. Number of units of the item purchased. Must be a whole number. If you do not provide this value, CyberSource uses 1. Level II Visa (R) Mastercard (R) Level III Visa (R) Mastercard (R) Level III Visa (R for interchange rates) Mastercard (R for interchange rates) Level III Level II and Level III Processing Using the SCMP API | June 2017 String (12) Visa (R for interchange rates) String (26) Visa: Integer (4) Mastercard: Integer (12) Mastercard (R for interchange rates) 102 Chapter 11 Table 21 OmniPay Direct: Level II and Level III Offer-Level Fields for OmniPay Direct (Continued) CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length tax_amount Tax Amount / Total Tax Amount Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. Level II Decimal (13) The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1 You include the following offer lines in your request: offer0=amount:10.00^ quantity:1^tax_ amount:0.80 Visa (R if national_tax is included) Mastercard (R for interchange rates) Level III Visa (R if national_tax is included) Mastercard (R for interchange rates) offer1=amount:20.00^ quantity:1^tax_ amount:1.60 2 The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. If you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. tax_rate Tax Rate / Detail Tax Rate Tax rate applied to the item. Level II Example 0.08 (=8%) Valid range: 0.01 to 0.99 (1% to 99%) Decimal (4) Visa (R for interchange rates) Level III Level II and Level III Processing Using the SCMP API | June 2017 Visa (R for interchange rates) Mastercard (R for interchange rates) 103 Chapter 11 Table 21 OmniPay Direct: Level II and Level III Offer-Level Fields for OmniPay Direct (Continued) CyberSource Field Name OmniPay Direct Field Name Description Used By (Required/ Optional) Data Type & Length tax_status_indicator Tax Collected Indicator Flag that indicates whether sales tax is included in the value for the total_amount field. Possible values: Level III String (1) Mastercard (O) Y: sales tax is included; total_ amount value must be greater than zero. total_amount Line Item Total / Extended Item Amount N: sales tax is not included; total_amount value must be zero. Total purchase amount for the item. Normally calculated as the unit price * quantity. Level II Visa (O) Mastercard (O) Decimal(12) Level III unit_of_measure Unit of Measure Code / Item Unit of Measure Unit of measure, or unit of measure code, for the item. See Appendix A, "Codes for Units of Measurement," on page 127. Level II and Level III Processing Using the SCMP API | June 2017 Visa (R) Mastercard (R) Level III String (12) Visa (R for interchange rates) 104 Chapter 11 OmniPay Direct: Level II and Level III Examples Example 1 Level II Capture Request for Visa auth_request_id=4756679462096005301540 ics_applications=ics_bill merchant_id=test_merchant merchant_ref_number=482046C3A7E94F5BD1FE3C66C merchant_vat_registration_number=GB-123445555 summary_commodity_code=SUMM supplier_order_reference=456456346 currency=USD freight_amount=0.00 grand_total_amount=9.95 offer0=tax_amount:1.00^national_tax:0.01^amount:1.99^total_amount:9.95^ quantity:5^alternate_tax_rate:0.01^tax_rate:0.05 commodity_code=2222 user_po=12345 Example 2 Level II Capture Reply for Visa request_id=4738626380736000501540 merchant_ref_number=482046C3A7E94F5BD1FE3C66C bill_bill_amount=9.95 bill_rcode=1 bill_rflag=SOK bill_rmsg=Request was processed successfully. bill_trans_ref_no=02850840187309570 currency=USD ics_rcode=1 ics_rflag=SOK ics_rmsg=Request was processed successfully. Level II and Level III Processing Using the SCMP API | June 2017 105 Chapter 11 Example 3 OmniPay Direct: Level II and Level III Level III Capture Request for Visa auth_request_id=4756679462096005301540 ics_applications=ics_bill merchant_id=test_merchant merchant_ref_number=482046C3A7E94F5BD1FE3C66C merchant_vat_registration_number=GB-123445555 summary_commodity_code=1234 supplier_order_reference=456456346 user_po=12345 currency=USD offer0=tax_amount:0.01^national_tax:0.01^amount:1.99^total_amount:9.95^ quantity:5^product_name:ABC Shirt - blue^tax_rate:0.05^ discount_amount:0.10^unit_of_measure:EAC^alternate_tax_rate:0.05 order_discount_amount=0.01 grand_total_amount=9.95 vat_tax_rate=0.08 freight_amount=0.00 national_tax_indicator=1 purchasing_level=3 Example 4 Level III Capture Reply for Visa request_id=4738626380736000501540 merchant_ref_number=482046C3A7E94F5BD1FE3C66C bill_bill_amount=9.95 bill_purchasing_level3_enabled=Y bill_rcode=1 bill_rflag=SOK bill_rmsg=Request was processed successfully. bill_trans_ref_no=02850840187309570 currency=USD ics_rcode=1 ics_rflag=SOK ics_rmsg=Request was processed successfully. Example 5 Level II Capture Request for Mastercard auth_request_id=4756679462096005301540 ics_applications=ics_bill merchant_id=test_merchant merchant_ref_number=482046C3A7E94F5BD1FE3C66C supplier_order_reference=482046C3A7E94 merchant_vat_registration_number=GB-123445555 currency=USD grand_total_amount=9.95 offer0=tax_amount:1.00^amount:1.99^total_amount:9.95^quantity:5 user_po=12345 Level II and Level III Processing Using the SCMP API | June 2017 106 Chapter 11 Example 6 OmniPay Direct: Level II and Level III Level II Capture Reply for Mastercard request_id=4738626380736000501540 merchant_ref_number=482046C3A7E94 bill_bill_amount=9.95 bill_rcode=1 bill_rflag=SOK bill_rmsg=Request was processed successfully. bill_trans_ref_no=02850840187309570 currency=USD ics_rcode=1 ics_rflag=SOK ics_rmsg=Request was processed successfully. Example 7 Level III Capture Request for Mastercard auth_request_id=4756679462096005301540 ics_applications=ics_bill merchant_id=test_merchant merchant_ref_number=482046C3A7E94F5BD1FE3C66C merchant_vat_registration_number=GB-123445555 supplier_order_reference=482046C3A7E94 offer0=tax_amount:1.00^amount:1.99^total_amount:9.95^quantity:5^ product_name:ABC Shirt - blue^tax_rate:0.05^discount_amount:0.10^ unit_of_measure:EAC currency=USD grand_total_amount=9.95 user_po=12345 purchasing_level=3 Example 8 Level III Capture Reply for Mastercard request_id=4738626380736000501540 merchant_ref_number=482046C3A7E94F5BD1FE3C66C bill_bill_amount=9.95 bill_purchasing_level3_enabled=Y bill_rcode=1 bill_rflag=SOK bill_rmsg=Request was processed successfully. bill_trans_ref_no=02850840187309570 currency=USD ics_rcode=1 ics_rflag=SOK ics_rmsg=Request was processed successfully. Level II and Level III Processing Using the SCMP API | June 2017 107 CHAPTER RBS WorldPay Atlanta: Level II and Level III 12 Important This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. Important When you send a capture request with Level II and Level III data, you must include the required fields for every capture request. For credit requests, RBS WorldPay Atlanta does not require you to indicate the request is for Level II or Level III processing. For information about the non-Level-II and non-Level-III fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Processor Specification The specification that CyberSource used to implement Level III processing for RBS WorldPay Atlanta is RBS Worldpay API message specification, version 7.1.0, June 2, 2009. Level II and Level III Processing Using the SCMP API | June 2017 108 Chapter 12 RBS WorldPay Atlanta: Level II and Level III Order-Level Fields Table 22 Order-Level Fields for RBS WorldPay Atlanta CyberSource Field Name RBS WorldPay Atlanta Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_ amount VAT Tax Amount Total amount of alternate tax included in the order. Amount cannot be greater than 999999.99. Level III Numeric (8) alternate_tax_ amount_indicator Alternate Tax Indicator Flag that indicates whether the alternate tax amount is included in the request. Possible values: Level III Mastercard (O) String (1) Mastercard (O) 0: alternate tax amount is not included in the request. duty_amount freight_amount grand_total_amount Duty Amount Freight Amount Amount 1: alternate tax amount is included in the request. Total charges for any import or export duties included in the order. Level III Visa (O) Mastercard (O) Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include grand_total_ amount. Level III Grand total for the entire capture or credit request. Level III Visa (O) Mastercard (O) Visa (R) Mastercard (R) merchant_vat_ registration_number Merchant VAT Number Your government-assigned tax identification number. Level III order_discount_ amount Discount Amount Total discount applied to the order. For example: a 20.00 discount off the order total. Discount amount cannot be greater than 999999.99. Level III purchaser_order_ date Order Date Date the order was processed. Format: YYMMDD. Level III purchaser_vat_ registration_number Customer VAT Number Customer’s government-assigned tax identification number. Level III Level II and Level III Processing Using the SCMP API | June 2017 Numeric (8) Numeric (8) String (15) String (20) Visa (O) Numeric (8) Visa (O) Numeric (6) Visa (R) String (13) Visa (O) 109 Chapter 12 Table 22 RBS WorldPay Atlanta: Level II and Level III Order-Level Fields for RBS WorldPay Atlanta (Continued) CyberSource Field Name RBS WorldPay Atlanta Field Name Description Used By (Required/ Optional) Data Type & Length purchasing_level No corresponding RBS WorldPay Atlanta field Flag that indicates the capture or credit request includes Level III data. Set the value for this field to 3. See "Requesting Captures and Credits with Level III Data," page 15. Level III String (1) Origin Zip 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. Level III ship_from_zip Visa (R) Mastercard (R) Visa (Recommended) Mastercard (Recommended) String (10) If the billing country is the U.S., the 9digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 If the billing country is Canada, the 6digit postal code must follow this format: [alpha][numeric][alpha] [space][numeric][alpha] [numeric] Example A1B 2C4 ship_to_country Destination Country Code Country of the shipping address. Use the two-character ISO Standard Country Codes. If you do not provide this value, CyberSource uses the bill_to_ country value. If you do not provide either of these values, CyberSource uses the default value of US. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (Recommended for best rate) Mastercard (R) String (3) 110 Chapter 12 Table 22 RBS WorldPay Atlanta: Level II and Level III Order-Level Fields for RBS WorldPay Atlanta (Continued) CyberSource Field Name RBS WorldPay Atlanta Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_zip Destination Zip Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level III String (10) When the shipping country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Visa (Recommended for best rate) Mastercard (Recommended for best rate. Do not use all zeros or nines.) 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 If the postal code for the shipping address is not included in the request message, CyberSource uses the postal code for the billing address. If the postal code for the billing address is not included in the request message, the postal code for the shipping address is required. summary_ commodity_code Commodity Code International description code of the overall order’s goods or services. Contact your acquirer for a list of codes. Level III tax_indicator Tax Exempt Flag that indicates whether an order is taxable. Possible values: Level II Y: the order is taxable. N: the order is not taxable. Note This field is required for Visa and Mastercard transactions that involve Level II data. If tax_amount equals 0, set this field to N. If tax_ amount is greater than 0, set this field to Y. Level II and Level III Processing Using the SCMP API | June 2017 String (4) Visa (O) Visa (R) Mastercard (R) String (1) Level III Visa (O) Mastercard (O) 111 Chapter 12 Table 22 RBS WorldPay Atlanta: Level II and Level III Order-Level Fields for RBS WorldPay Atlanta (Continued) CyberSource Field Name RBS WorldPay Atlanta Field Name Description Used By (Required/ Optional) Data Type & Length user_po PC2 Customer ID Value used by your customer to identify the order. This value is typically a purchase order number. Level II String (25) Visa (Required for purchase/ procurement cards; optional otherwise. Do not use all zeros or nines.) Mastercard (Required for purchase/ procurement cards; optional otherwise. Do not use all zeros or nines.) Level III vat_invoice_ref_ number VAT Invoice Number VAT invoice number associated with the transaction. Level II and Level III Processing Using the SCMP API | June 2017 Visa (Required for purchase/ procurement cards; optional otherwise. Do not use all zeros or nines.) Mastercard (Required for purchase/ procurement cards; optional otherwise. Do not use all zeros or nines.) Level III String (15) Visa (O) 112 Chapter 12 Table 22 RBS WorldPay Atlanta: Level II and Level III Order-Level Fields for RBS WorldPay Atlanta (Continued) CyberSource Field Name RBS WorldPay Atlanta Field Name Description Used By (Required/ Optional) Data Type & Length vat_tax_amount VAT Tax Amount Total amount of VAT or other tax included in the order. Amount cannot be greater than 999999.99. Level III Numeric (8) Tax Rate Rate of VAT or other tax for the order. Level III Example 0.0400 (=4%) vat_tax_rate Visa (O) Numeric (4) Visa (O) Valid range: 0.0001 to 0.9999 (0.01% to 99.99%) Offer-Level Fields Table 23 Offer-Level Fields for RBS WorldPay Atlanta CyberSource Field Name RBS WorldPay Atlanta Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_id Alternate Tax ID Your tax ID number to use for the alternate tax amount. You must provide this value if you include Alternate Tax Amount in the request. Providing this value is optional if you do not Alternate Tax Amount. Level III String (15) Unit Cost Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Level II amount Important For a Level III Mastercard (See description) Visa (R) Mastercard (R) Visa: Numeric (10) Mastercard: Numeric (8) Level III Visa (R) Mastercard (R) transaction, this value cannot be zero (0). commodity_code Commodity Code International description code used to classify the item. Contact your acquirer for a list of codes. Level II and Level III Processing Using the SCMP API | June 2017 Level III String (12) Visa (R) 113 Chapter 12 Table 23 RBS WorldPay Atlanta: Level II and Level III Offer-Level Fields for RBS WorldPay Atlanta (Continued) CyberSource Field Name RBS WorldPay Atlanta Field Name Description Used By (Required/ Optional) Data Type & Length discount_amount Discount Amount Discount applied to the item. Level III Numeric (8) discount_rate Discount Rate Visa (O) Mastercard (O) Rate the item is discounted. Level III Example 5.25 (=5.25%) Numeric (5) Mastercard (O) Maximum amount is 99.99. gross_net_indicator invoice_number product_code Gross Net Indicator Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: Y: item amount includes tax amount N: item amount does not include tax amount Level III String (1) Mastercard (R) No corresponding RBS WorldPay Atlanta field Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Level III Product Code Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is default. See Appendix B, "Product Codes," on page 134 for a list of valid values. Level III Visa (O) Mastercard (O) Visa (R) Mastercard (R) String (23) String (12) For ics_auth, when you set this field to a value other than default or any of the values related to shipping and handling, the quantity, product_name, and merchant_product_sku fields are required. Level II and Level III Processing Using the SCMP API | June 2017 114 Chapter 12 Table 23 RBS WorldPay Atlanta: Level II and Level III Offer-Level Fields for RBS WorldPay Atlanta (Continued) CyberSource Field Name RBS WorldPay Atlanta Field Name Description Used By (Required/ Optional) Data Type & Length product_name Description Text description of the item. Level III String (35) quantity Quantity The quantity of the items purchased. Cannot be more than 999999.99. Visa (R) Mastercard (R. Do not use all zeros or spaces.) Level III tax_amount Tax Amount Total tax to apply to the product. This value cannot be negative. If no tax is present, you can send in a value of 0. The tax_amount field is additive. For example, if you include the following offer lines: offer0=amount:10.00^ quantity:1^tax_amount: 0.80 Visa (Recommended for best rate) Visa: Numeric (10) Mastercard: Numeric (8) Mastercard (Recommended for best rate) Level II Visa (R) Mastercard (R) Numeric (8) Level III Visa (R) Mastercard (R) offer1=amount:20.00^ quantity:1^tax_amount: 1.60 the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included. The tax_amount and the amount must be in the same currency. If you want to include tax_ amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. tax_rate Tax Rate Tax rate applied to the item. Level III Valid range is 0.0001 to 0.9999 (0.01% to 99.99%). The value can also be zero. Visa (O) Mastercard (O) Level II and Level III Processing Using the SCMP API | June 2017 Numeric (4) 115 Chapter 12 Table 23 RBS WorldPay Atlanta: Level II and Level III Offer-Level Fields for RBS WorldPay Atlanta (Continued) CyberSource Field Name RBS WorldPay Atlanta Field Name Description Used By (Required/ Optional) Data Type & Length tax_type_applied Tax Type Type of tax being applied to the item. Possible values: Level III Numeric (4) 0000: unknown tax type 0001: federal/national sales Mastercard (R) tax 0002: state sales tax 0003: city sales tax 0004: local sales tax 0005: municipal sales tax 0006: other tax 0010: value-added tax 0011: goods and services tax 0012: provincial sales tax 0013: harmonized sales tax 0014: Quebec sales tax (QST) 0020: room tax 0021: occupancy tax 0022: energy tax Blank: Tax not supported on line item. total_amount unit_of_measure Line Total Unit Of Measure Total purchase amount for the item. Normally calculated as the unit price x quantity. Unit of measure, or unit of measure code, for the item. See Appendix A, "Codes for Units of Measurement," on page 127. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (R) Mastercard (R. Do not use all zeros or spaces.) Level III Visa (R) Mastercard (R) Numeric (8) String (12) 116 CHAPTER TSYS Acquiring Solutions: Level II and Level III 13 CyberSource does not presently support Level II processing for the American Express card type on TSYS Acquiring Solutions. Important Important Important This document provides guidelines that indicate which fields are needed to obtain the best interchange rates. These guidelines are based on industry information. CyberSource recommends that you contact your acquirer for the most current information because the payment card companies can change their requirements at any time. When you send a capture or credit request with Level II and/or Level III data, you must include the required fields for every capture or credit request. For information about the non-Level-II and non-Level-III fields required for capture and credit requests, see Credit Card Services Using the SCMP API. Processor Specification The specification that CyberSource used to implement Level III processing for TSYS Acquiring Solutions (Vital) is Vital’s EIS 1081, Level III Line Item Processing, version 6.4, April 2004. The records referenced are: Transaction Detail Record — Optional Data; Groups 25, 26, and 27 Visa Card Non-T&E and Fleet (Non-fuel) Line Item Detail Record Mastercard Non-T&E and Fleet (Non-fuel) Line Item Detail Record Level II and Level III Processing Using the SCMP API | June 2017 117 Chapter 13 TSYS Acquiring Solutions: Level II and Level III Order-Level Fields Table 24 Order-Level Fields for TSYS Acquiring Solutions CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_ amount Alternate Tax Amount Total amount of alternate tax for the order. Level III Decimal (10) alternate_tax_ amount_indicator Alternate Tax Amount Indicator Flag that indicates whether an alternate tax amount is included in the order total. Possible values: duty_amount freight_amount grand_total_amount local_tax Duty Amount 1: alternate tax is included 0: alternate tax not included Total charges for any import or export duties included in the order. Mastercard (O) Level III Mastercard (O) Level III Visa (O) Mastercard (O) Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include grand_total_amount. Level III No corresponding TSYS Acquiring Solutions field Grand total for the entire capture or credit request. Level III Local Tax Sales tax for the order. Freight Amount Level II and Level III Processing Using the SCMP API | June 2017 String (1) Visa (O) Mastercard (O) Visa (R) Mastercard (R) Level III Visa (O) Mastercard (O) Decimal (13) Decimal (13) Decimal (15) Decimal (13) 118 Chapter 13 Table 24 TSYS Acquiring Solutions: Level II and Level III Order-Level Fields for TSYS Acquiring Solutions (Continued) CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length local_tax_indicator Local Tax Included Flag Flag that indicates whether local sales tax is included in the order total. Possible values: Level III String (1) 0: local sales tax not included 1: local sales tax included 2: tax exempt order Visa (O) Mastercard (O) 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, please contact your acquirer. merchant_vat_ registration_number Merchant VAT Registration Number Your government-assigned tax identification number. Level III national_tax National Tax Amount National tax for the order. Level III national_tax_ indicator 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 String (20) Visa (O) Visa (O) Mastercard (O) Level III Visa (O) Mastercard (O) Decimal (13) String (1) If you do not provide this value, CyberSource sets this field to 1 if you provide a National Tax Amount greater than 0. order_discount_ amount Discount Amount Total discount applied to the order. For example: a 20.00 discount off the order total. Level II and Level III Processing Using the SCMP API | June 2017 Level III Decimal (13) Visa (O) 119 Chapter 13 Table 24 TSYS Acquiring Solutions: Level II and Level III Order-Level Fields for TSYS Acquiring Solutions (Continued) CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length purchaser_order_ date Order Date Date the order was processed. Format: YYMMDD. Level III String (6) purchaser_vat_ registration_number Customer VAT Registration Number Customer’s government-assigned tax identification number. Level III purchasing_level No corresponding TSYS Acquiring Solutions field Flag that indicates the capture or credit request includes Level III data. Set the value for this field to 3. See "Requesting Captures and Credits with Level III Data," page 15. Level III 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. ship_from_zip Visa (O) Visa (O) Visa (R) Mastercard (R) Level III Visa (O) Mastercard (Recommended for best rate. Do not use all zeros or nines.) If the billing country is the U.S., the 9digit postal code must follow this format: [5 digits][dash][4 digits] String (13) String (1) String (10) Example 12345-6789 If the billing country is Canada, the 6digit postal code must follow this format: [alpha][numeric][alpha] [space][numeric][alpha] [numeric] Example A1B 2C4 ship_to_country ship_to_state Destination Country Code No corresponding TSYS Acquiring Solutions field Country of the shipping address. Use the two-character ISO Standard Country Codes. State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. Level II and Level III Processing Using the SCMP API | June 2017 Level III Visa (Recommended for best rate) Mastercard (Optional but recommended) If any shipping information is in the request, this field is required for CyberSource frontend processing. String (2) String (2) 120 Chapter 13 Table 24 TSYS Acquiring Solutions: Level II and Level III Order-Level Fields for TSYS Acquiring Solutions (Continued) CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length ship_to_zip Destination Postal/ZIP Code Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Level III String (10) When the shipping country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Visa (Recommended for best rate) Mastercard (Recommended for best rate. Do not use all zeros or nines.) 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 ship_from_zip when your customer takes possession of the items at your location. summary_ commodity_code Summary Commodity Code International description code of the overall order’s goods or services. Contact your acquirer for a list of codes. Level II and Level III Processing Using the SCMP API | June 2017 Level III String (4) Visa (R) 121 Chapter 13 Table 24 TSYS Acquiring Solutions: Level II and Level III Order-Level Fields for TSYS Acquiring Solutions (Continued) CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length user_po 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 String (25) Visa (Required for purchase/ procurement cards; optional otherwise. Do not use all zeros or nines.) Mastercard (Required for purchase/ procurement cards; optional otherwise. Do not use all zeros or nines.) Level III Visa (Required for purchase/ procurement cards; optional otherwise. Do not use all zeros or nines.) Mastercard (Required for purchase/ procurement cards; optional otherwise. Do not use all zeros or nines.) vat_invoice_ref_ number Unique VAT Invoice Reference Number VAT invoice number associated with the transaction. Level III vat_tax_amount VAT/Tax Amount Total amount of VAT or other tax included in the order. Level III Level II and Level III Processing Using the SCMP API | June 2017 String (15) Visa (O) Decimal (13) Visa (O) 122 Chapter 13 Table 24 TSYS Acquiring Solutions: Level II and Level III Order-Level Fields for TSYS Acquiring Solutions (Continued) CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length vat_tax_rate VAT/Tax Rate Rate of VAT or other tax for the order. Level III Decimal (6) Example 0.0400 (=4%) Visa (O) Valid range: 0.0001 to 0.9999 (0.01% to 99.99%) Offer-Level Fields Table 25 Offer-Level Fields for TSYS Acquiring Solutions CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length alternate_tax_id Alternate Tax Identifier Your tax ID number to use for the alternate tax amount. You must provide this value if you include Alternate Tax Amount in the request. Providing this value is optional if you do not Alternate Tax Amount. Level III String (15) Unit Cost Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. Level II amount Important For a Level III Mastercard (See description) Visa (R) Mastercard (R) Decimal (11) Level III Visa (R) Mastercard (R) transaction, this value cannot be zero (0). commodity_code discount_amount Item Commodity Code International description code used to classify the item. Contact your acquirer for a list of codes. Level III Visa: Discount Per Line Item Discount applied to the item. Level III Mastercard: Discount Amount Level II and Level III Processing Using the SCMP API | June 2017 String (12) Visa (R) Visa (O) Mastercard (O) Decimal (13) 123 Chapter 13 Table 25 TSYS Acquiring Solutions: Level II and Level III Offer-Level Fields for TSYS Acquiring Solutions (Continued) CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length discount_indicator Discount Indicator Flag that indicates whether the amount is discounted. Possible values: Level III String (1) Y: amount is discounted N: amount is not discounted Mastercard (O) If you do not provide this value but you set Discount Amount to a value greater than zero, CyberSource sets this field to Y. discount_rate gross_net_indicator invoice_number product_code Item Discount Rate Rate the item is discounted. Level III Example 5.25 (=5.25%) Net/Gross Indicator Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: Y: item amount includes tax amount N: item amount does not include tax amount Mastercard (O) Level III String (6) String (1) Mastercard (R) No corresponding TSYS Acquiring Solutions field Field to support an invoice number for a transaction. You must specify the number of offer lines that will include an invoice number. By default, the first offer line includes an invoice number field. The invoice number field can be included for up to 10 offer lines. Level III Product Code Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is default. See Appendix B, "Product Codes," on page 134 for a list of valid values. Level III Visa (O) Mastercard (O) Visa (O) Mastercard (Recommended for best rate. Do not use all zeros or spaces.) String (23) String (12) For ics_auth, when you set this field to a value other than default or any of the values related to shipping and handling, the quantity, product_name, and merchant_product_sku fields are required. Level II and Level III Processing Using the SCMP API | June 2017 124 Chapter 13 Table 25 TSYS Acquiring Solutions: Level II and Level III Offer-Level Fields for TSYS Acquiring Solutions (Continued) CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length product_name Visa: Item Descriptor Text description of the item. Level III String (35) Mastercard: Item Description quantity Visa: Quantity Mastercard: Item Quantity tax_amount Visa: VAT/Tax Amount Mastercard: Tax Amount Number of units of the item purchased. Must be a whole number. If you do not provide this value, CyberSource uses 1. Total tax to apply to the product. This value cannot be negative. The tax_amount field is additive. For example, if you include the following offer lines: offer0=amount:10.00^ quantity:1^tax_: 0.80 Visa (O) Mastercard (R. Do not use all zeros or spaces.) Level III Visa (Recommended for best rate) Mastercard (Recommended for best rate. Do not use all zeros or spaces.) Level II Visa (R) Mastercard (R) Integer (12) Decimal (13) Level III Visa (R) Mastercard (R) offer1=amount:20.00^ quantity:1^tax_: 1.60 the total amount authorized will be for 32.40, not 30.00 with 2.40 of tax included. The tax_amount and the amount must be in the same currency. If you want to include tax_ amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. tax_rate Visa: VAT/Tax Rate Mastercard: Tax Rate Applied Tax rate applied to the item. Level III Valid range is 0.0001 to 0.9999 (0.01% to 99.99%). The value can also be zero. Visa (O) Mastercard (R) Level II and Level III Processing Using the SCMP API | June 2017 Decimal (6) 125 Chapter 13 Table 25 TSYS Acquiring Solutions: Level II and Level III Offer-Level Fields for TSYS Acquiring Solutions (Continued) CyberSource Field Name TSYS Acquiring Solutions Field Name Description Used By (Required/ Optional) Data Type & Length tax_type_applied Tax Type Applied Type of tax being applied to the item. Level III String (4) Visa: Line Item Total Total purchase amount for the item. Normally calculated as the unit price x quantity. Level III total_amount Mastercard: Extended Item Amount unit_of_measure Visa: Unit of Measure/Code Mastercard: Item Unit of Measure Unit of measure, or unit of measure code, for the item. See Appendix A, "Codes for Units of Measurement," on page 127. Level II and Level III Processing Using the SCMP API | June 2017 Mastercard (O) Visa (R) Mastercard (R. Do not use all zeros or spaces.) Level III Visa (O) Mastercard (R. Do not use all zeros or spaces.) Visa: Decimal (13) Mastercard: Decimal (10) String (12) 126 APPENDIX Codes for Units of Measurement A The following table lists the codes for units of measurement used in international trade. Table 26 Codes for Units of Measurement Value Description EA Unknown unit of measure ACR Acre (4840 yd2) AMH Ampere-hour (3.6 kC) AMP Ampere ANN Year APZ Ounce GB, US (31.10348 g) (tr oz.) ARE Are (100 m2) ASM Alcoholic strength mass ASV Alcoholic strength by volume ATM Standard atmosphere (101325 Pa) ATT Technical atmosphere (98066.5 Pa) BAR Bar BFT Board foot BG Unknown unit of measure BHP Brake horsepower (745.7 W) BHX Hundred boxes BIL Billion Eur (trillion US) BLD Dry barrel (115.627 dm3) BLL Barrel BQL Becquerel BTU British thermal unit (1.055 Kilojoules) BUA Bushel (35.2391 dm3) BUI Bushel (36.36874 dm3) BX Unknown unit of measure C Unknown unit of measure CA Unknown unit of measure Level II and Level III Processing Using the SCMP API | June 2017 127 Appendix A Table 26 Codes for Units of Measurement Codes for Units of Measurement (Continued) Value Description CCT Carrying capacity in metric tons CD Unknown unit of measure CDL Candela CEL Celsius degrees CEN Hundred CGM Centigram CKG Coulomb per kg CLF Hundred leaves CLT Centiliter CMK Square centimeter CMT Centimeter CNP Hundred packs CNT Cental GB (45.359237 kg) COU Coulomb CS Unknown unit of measure CTM Metric carat (200 Mg = 2.10-4 kg) CUR Curie CWA Hundredweight US (45.3592 kg) D Unknown unit of measure DAA Decare DAD Ten days DAY Day DEC Decade (10 years) DLT Deciliter DMK Square decimeter DMQ Cubic decimeter DMT Decimeter DPC Dozen pieces DPT Displacement tonnage DRA Dram US (3.887935 g) DRI Dram GB (1.771745 g) DRL Dozen rolls DRM Drachm gm (3.887935 g) DTH Hectokilogram DTN Centner / Quintal, metric (100 kg) (decitonne) Level II and Level III Processing Using the SCMP API | June 2017 128 Appendix A Table 26 Codes for Units of Measurement Codes for Units of Measurement (Continued) Value Description DWT Pennyweight GB, US (1.555174 g) DZ Unknown unit of measure DZN Dozen DZP Dozen packs DZR Dozen pairs EA Unknown unit of measure EAC Each FAH Fahrenheit degrees FAR Farad FOT Foot (.3048 m) FT Unknown unit of measure FTK Square foot FTQ Cubic foot G Unknown unit of measure GAL Unknown unit of measure GBQ Gigabequerel GFI Gram of fissile isotopes GGR Great gross (12 gross) GIA Gill (11.8294 cm3) GII Gill (0.142065 dm3) GLD Dry gallon (4.404884 dm3) GLI Gallon (4.546092 dm3) GLL Liquid gallon (3.78541 dm3) GRM Gram GRN Grain GB, US (64.798910 mg) GRO Gross GRT Gross (Register) ton GWH Gigawatt-hour (1 Million kWh HAR Hectare HBA Hectobar HGM Hectogram HIU Hundred international units HLT Hectoliter HMQ Million cubic meters HMT Hectometer Level II and Level III Processing Using the SCMP API | June 2017 129 Appendix A Table 26 Codes for Units of Measurement Codes for Units of Measurement (Continued) Value Description HPA Hectoliter of pure alcohol HTZ Hertz HUR Hour INH Inch (25.4 mm) INK Square inch INQ Cubic inch ITM Item JOU Joule KBA Kilobar KEL Kelvin KGM Kilogram KGS Kilogram per second KHZ Kilohertz KJO Kilojoule KMH Kilometer per hour KMK Square kilometer KMQ Kilogram per cubic meter KMT Kilometer KNI Kilogram of nitrogen KNS Kilogram of named substance KNT Knot (1 nautical mile per hour) KPA Kilopascal KPH Kilogram of caustic potash (kilogram of potassium hydroxide) KPO Kilogram of potassium oxide KPP Kilogram of phosphoric anhydride (kilogram of phosphoric pentoxide) KSD Kilogram of substance 90% dry KSH Kilogram of caustic soda KTN Kilotonne KUR Kilogram of uranium KVA Kilovolt-ampere KVR Kilovar KVT Kilovolt KWH Kilowatt-hour Level II and Level III Processing Using the SCMP API | June 2017 130 Appendix A Table 26 Codes for Units of Measurement Codes for Units of Measurement (Continued) Value Description KWT Kilowatt LBR Pound GB, US (0.45359237 kg) LBS Unknown unit of measure LBT Troy pound, US (373.242 g) LEF Leaf LPA Liter of pure alcohol LTN Long ton GB, US (1.0160469 T) LTR Liter (1 dm3) LUM Lumen LUX Lux MAL Megaliter MAM Megameter MAW Megawatt MBE Thousand standard brick equivalent MBF Thousand board-feet (2.36 m3) MBR Millibar MCU Millicurie MGM Milligram MHZ Megahertz MIK Square mile MIL Thousand MIN Minute MIO Million MIU Million international units MLD Billion US (milliard) MLT Milliliter MMK Square millimeter MMQ Cubic millimeter MMT Millimeter MON Month MPA Megapascal MQH Cubic meter per hour MQS Cubic meter per second MSK Meter per second squared MTK Square meter Level II and Level III Processing Using the SCMP API | June 2017 131 Appendix A Table 26 Codes for Units of Measurement Codes for Units of Measurement (Continued) Value Description MTQ Cubic meter MTR Meter MTS Meter per second MVA Megavolt-ampere (1000 kva) MWH Megawatt-hour (1000 kWh) NAR Number of articles NBB Number of bobbins NCL Number of cells NEW Newton NIU Number of international units NMB Number NMI Nautical mile (1852 m) NMP Number of packs NMR Number of pairs NPL Number of parcels NPT Number of parts NRL Number of rolls NTT Net (register) ton OHM Ohm ONZ Ounce GB, US (28.349523 g) OZA Fluid ounce (29.5735 cm3) OZI Fluid ounce (28.413 cm3) PAL Pascal PCB Piece PCE Unknown unit of measure PER Unknown unit of measure PGL Proof gallon PK Unknown unit of measure PTD Dry pint (0.55061 dm3) PTI Pint (0.568262 dm3) PTL Liquid pint (0.473176 dm3) QAN Quarter (of a year) QTD Dry quart (1.101221 dm3) QTI Quart (1.136523 dm3) QTL Liquid quart (0.946353 dm3) Level II and Level III Processing Using the SCMP API | June 2017 132 Appendix A Table 26 Codes for Units of Measurement Codes for Units of Measurement (Continued) Value Description QTR Quarter, GB (12.700586 kg) RL Unknown unit of measure RM Unknown unit of measure RPM Revolution per minute RPS Revolution per second SAN Half year (6 months) SCO Score SCR Scruple GB, US (1.295982 g) SEC Second SET Set SHT Shipping ton SIE Siemens SMI (Statute) mile (1609.344 m) SST Short Standard (7200 matches) ST Unknown unit of measure STI Stone GB (6.350293 kg) STN Short ton GB, US (0.90718474 T) TAH Thousand ampere-hour TNE Metric ton (1000 kg) (tonne (1000 kg)) TPR Ten pairs TQD Thousand cubic meters per day TRL Trillion EUR TSD Tonne of substance 90% dry TSH Ton of steam per hour VLT Volt WCD Cord (3.63 m3) WEB Weber WEE Week WHR Watt-hour WSD Standard WTT Watt YDK Square yard YDQ Cubic yard YRD Yard (0.9144 m) Level II and Level III Processing Using the SCMP API | June 2017 133 APPENDIX Product Codes B The following table lists the values you can use for the product code in the product_code offer-level field. Table 27 Product Codes Product Code Definition adult_content Adult content. coupon Coupon applied to the entire order. default Default value for the product code. CyberSource uses default when a request message does not include a value for the product code. electronic_good Electronic product other than software. electronic_software Software distributed electronically rather than on disks or other media. gift_certificate Gift certificate. handling_only Fee that you charge your customer to cover your administrative selling costs. service Service that you perform for your customer. shipping_and_handling The shipping portion is the charge for shipping the product to your customer. The handling portion is the fee you charge your customer to cover your administrative selling costs. shipping_only Charge for transporting tangible personal property from your location to your customer. You must maintain documentation that clearly establishes the location where the title to the property passed from you to your customer. subscription Subscription to a web site or other content. Level II and Level III Processing Using the SCMP API | June 2017 134 ">
/
ダウンロード
念のためお知らせします。ドキュメントはここで直接表示できます。しかし最も重要なことは、私たちのAIがすでにそれを読んでいるということです。複雑なことを簡単な言葉で説明したり、あらゆる言語で質問に答えたり、最も長く複雑なドキュメントでもすばやくナビゲートしたりできます。
広告