Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | Next revision Both sides next revision | ||
|
developer:api_specification:hpp_payment_features [2019/12/16 15:17] robinc [Notes and Details About the Request] |
developer:api_specification:hpp_payment_features [2019/12/16 15:33] robinc [Notes and Details on the Response] Added ND006 Level 3 |
||
|---|---|---|---|
| Line 283: | Line 283: | ||
| For more details on this feature, visit the **[[merchant:new_merchant:products#secure_card|Products - Secure Card]]** section. | For more details on this feature, visit the **[[merchant:new_merchant:products#secure_card|Products - Secure Card]]** section. | ||
| + | |||
| + | **ND006 - Level 3 Data Validation** | ||
| + | |||
| + | This field is associated with the Transaction Enhanced Data feature. "Allow Enhanced Data (Level II and Level III)" must be enabled, with the "Transaction Data Level" option set as "Level III" on the Processing Terminal "Features" section. | ||
| + | |||
| + | To provide a transaction with Level 3, your request needs to add the LEVEL_2_DATA (described before) and the LEVEL_3_DATA components and their fields. | ||
| + | The LEVEL_3_DATA component fields are described below. | ||
| + | |||
| + | ^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^ | ||
| + | | SUMMARY | N | Subcomponent of Level 3. Agregates the sum of different values within the transaction.| | ||
| + | | TOTAL_DISCOUNT_AMOUNT | N | Subfield of SUMMARY. Represents the freight amount applied to the sale. \\ Decimal value, allowing max of 13 digits within min value of 0. | | ||
| + | | TOTAL_DUTY_AMOUNT | N | Subfield of SUMMARY. Represents duty applied to the sale. \\ Decimal value, allowing max of 13 digits with min value of 0. | | ||
| + | | LINE_ITEMS | N | Subcomponent of Level 3. List of all items in which the sale is broken down. | | ||
| + | | LINE_ITEM | N | Subfield of LINE_ITEMS. Holds all the details of a sale's item. You can add as much as necessary to express the breaking down of your sale. | | ||
| + | | COMMODITY_CODE | N | Subfield of LINE_ITEM. Item's commodity code, defined for trade tariff. Widely used by corporate purchasing organizations to segment and manage their total spend accross diverse product lines. Defined at government or commercail agreements level. Consult your Acquirer for more details. | | ||
| + | | PRODUCT_CODE | N | Subfield of LINE_ITEM. This is the merchant's identifier for the product, also known as Universal Product code (UPC). | | ||
| + | | DESCRIPTION | N | Subfield of LINE_ITEM. This is the merchant's description for the product. | | ||
| + | | QUANTITY | N | Subfield of LINE_ITEM. Quantity of the specific item for the sale. | | ||
| + | | UNIT_OF_MEASURE | N | Subfield of LINE_ITEM. Measure unit used for this specific item type to sell it in parts, units or sets. | | ||
| + | | UNIT_PRICE | N | Subfield of LINE_ITEM. Unit price applied for that specific type of item and measure unit, within the sale. | | ||
| + | | DISCOUNT_RATE | N | Subfield of LINE_ITEM. A % of discount applied to the item total (quantity x unit price) before taxes. | | ||
| + | | TAX_RATE | N | Subfield of LINE_ITEM. A % of tax applied to the item total (quantity x unit price) after discounts. | | ||
| + | | TOTAL_AMOUNT | N | Subfield of LINE_ITEM. Final item value based on total (quantity x unit price) after discount and tax applied. | | ||
| + | |||
| + | Quick Example | ||
| + | |||
| + | <code xml> | ||
| + | <LEVEL_2_DATA>...</LEVEL_2_DATA> | ||
| + | <LEVEL_3_DATA> | ||
| + | <SUMMARY> | ||
| + | <TOTAL_DISCOUNT_AMOUNT>61.30</TOTAL_DISCOUNT_AMOUNT> | ||
| + | <TOTAL_FREIGHT_AMOUNT>3.50</TOTAL_FREIGHT_AMOUNT> | ||
| + | <TOTAL_DUTY_AMOUNT>11.50</TOTAL_DUTY_AMOUNT> | ||
| + | </SUMMARY> | ||
| + | <LINE_ITEMS> | ||
| + | <!-- As many as necessary --> | ||
| + | <LINE_ITEM> | ||
| + | <COMMODITY_CODE>PDX001</COMMODITY_CODE> | ||
| + | <PRODUCT_CODE>DSV1303.090.00001</PRODUCT_CODE> | ||
| + | <DESCRIPTION>General services</DESCRIPTION> | ||
| + | <QUANTITY>10</QUANTITY> | ||
| + | <UNIT_OF_MEASURE>Hour</UNIT_OF_MEASURE> | ||
| + | <UNIT_PRICE>105.50</UNIT_PRICE> | ||
| + | <DISCOUNT_RATE>5.00</DISCOUNT_RATE> | ||
| + | <TAX_RATE>12.50</TAX_RATE> | ||
| + | <TOTAL_AMOUNT>1127.53</TOTAL_AMOUNT> | ||
| + | </LINE_ITEM> | ||
| + | <LINE_ITEM> | ||
| + | <COMMODITY_CODE>PDX002</COMMODITY_CODE> | ||
| + | <PRODUCT_CODE>DSV1302.090.00001</PRODUCT_CODE> | ||
| + | <DESCRIPTION>General services</DESCRIPTION> | ||
| + | <QUANTITY>2</QUANTITY> | ||
| + | <UNIT_OF_MEASURE>Hour</UNIT_OF_MEASURE> | ||
| + | <UNIT_PRICE>85.50</UNIT_PRICE> | ||
| + | <DISCOUNT_RATE>5.00</DISCOUNT_RATE> | ||
| + | <TAX_RATE>16.00</TAX_RATE> | ||
| + | <TOTAL_AMOUNT>188.44</TOTAL_AMOUNT> | ||
| + | </LINE_ITEM> | ||
| + | </LINE_ITEMS> | ||
| + | </LEVEL_3_DATA> | ||
| + | |||
| + | </code> | ||
| + | |||
| + | <WRAP center box info 100%> | ||
| + | **DON'T FORGET** \\ If you are using LEVEL_3_DATA compononent, also add to your request the LEVEL_2_DATA 2 component to attempt a full qualification for enhanced data. | ||
| + | </WRAP> | ||
| \\ | \\ | ||