--- developer:api_specification:hpp_payment_features [2019/12/16 15:17]
robinc [Notes and Details About the Request]
+++ developer:api_specification:hpp_payment_features [2022/03/31 08:30]
lezlieh update with secure token
@@ Line 74: / Line 74: @@
 | LINE_ITEM_'N'_TOTAL_AMOUNT |  N  |Final item value based on total (quantity x unit price) after discount and tax applied. Max of 13 characters and 3 decimal points, depending on your terminal's currency. See **ND006** for more details.|
 | CUSTOMFIELD |	N	| Any of the available Custom Fields for the Terminal. If there are Custom Fields enabled for the particular Terminal in use, the Hosted Page is gonna show the ones not sent on request and hide the ones sent, pre-populating them with the informed values. Their values are going to be stored and used by the Payment Gateway for the requests sent to the Receipt URL and the Validation URL. To understand more visit the section regarding **[[developer:api_specification:special_fields_and_parameters|Special Fields and Parameters]]**. |
-| ORIGNALBRANDTXIDENTIFIER |	N	| String, max length is 64 - Merchant sends the transaction identifier received from acquirer See note **ND0008 - Stored Credential use field behavior and settings**. |
+| ORIGNALBRANDTXIDENTIFIER |	N	| String, max length is 64 - Merchant sends the transaction identifier received from acquirer See note **ND008 - Stored Credential use field behavior and settings**. |
-| STOREDCREDENTIALUSE |  N  |UNSCHEDULED, INSTALLMENT or RECURRRING. See note **ND0008 - Stored Credential use field behavior and settings**.|
+| STOREDCREDENTIALUSE |  N  |UNSCHEDULED, INSTALLMENT or RECURRRING. See note **ND008 - Stored Credential use field behavior and settings**.|
-| STOREDCREDENTIALTXTYPE |	N	| FIRST_TXN, SUBSEQUENT_MERCHANT_INITIATED_TXN or SUBSEQUENT_CARDHOLDER_INITIATED_TXN. See note **ND0008 - Stored Credential use field behavior and settings**. |
+| STOREDCREDENTIALTXTYPE |	N	| FIRST_TXN, SUBSEQUENT_MERCHANT_INITIATED_TXN or SUBSEQUENT_CARDHOLDER_INITIATED_TXN. See note **ND008 - Stored Credential use field behavior and settings**. |
+| BYPASS_SURCHARGE  |  N  | Send a value of 'true' to identify that surcharge has not been applied to this payment. Only applicable if surcharging is enabled for the terminal.|
 </searchtable>
@@ Line 112: / Line 113: @@
 \\
-**ND003 - Secure Card Registration by Payment Request**
+**ND003 - Secure Token Registration by Payment Request**
-It is also possible to take advantage of a Payment Request to register a Secure Card. In this case, the following extra parameter should also be included at the request body:
+It is also possible to take advantage of a Payment Request to register a Secure Token. In this case, the following extra parameter should also be included at the request body:
 ^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^
@@ Line 135: / Line 136: @@
 **ND008 - Stored Credential use field behavior and settings**
-This feature is currently available to TSYS Saratoga terminals and is configurable by customer support. These fields will only be used on a payment if you have secure card storage enabled. The fields will have the following behavior: Hidden - the gateway accepts the fields, if sent, and adds them to the transaction, but does not show it for the customer.
+This feature is currently available to TSYS Saratoga terminals. The COF tags are required for the following usage:
+  * • Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway).
+The fields will have the following behavior: Hidden - the gateway accepts the fields, if sent, and adds them to the transaction, but does not show it for the customer.
+To provide a transaction with COF, your request needs to add the Credential on File component and its fields, as described below.
+^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^
+| ORIGINALBRANDTXIDENTIFIER  | N | String, max length is 64, Merchant sends the transaction identifier if received from acquirer. |
+| STOREDCREDENTIALTXTYPE | N | Possible values: FIRST_TXN_SUBSEQUENT_MERCHANT_INITIATED_TXN or SUBSEQUENT_CARDHOLDER_INITITATED_TXN |
+| STOREDCREDENTIALUSE | N | Possible values: UNSCHEDULED, INSTALLMENT or RECURRING. |
 ==== Examples for a Request ====
@@ Line 234: / Line 248: @@
 </WRAP>
-  * __When the original request also requested the registering of a Secure Card__:
+  * __When the original request also requested the registering of a Secure Token__:
 <WRAP center box 100%>
@@ Line 248: / Line 262: @@
 </WRAP>
-  * __When the original request also requested the registering of a Secure Card__:
+  * __When the original request also requested the registering of a Secure Token__:
 <WRAP center box 100%>
@@ Line 267: / Line 281: @@
 \\
-**ND004 - Secure Card Registration by Payment Request**
+**ND004 - Secure Token Registration by Payment Request**
-When the **SECURECARDMERCHANTREF** field is sent on request, the Payment Gateway understands that you desire to create a Secure Card from the
+When the **SECURECARDMERCHANTREF** field is sent on request, the Payment Gateway understands that you desire to create a Secure Token from the
 card data used for the transaction. In this case, the following extra parameter are going to be added to the response body:
@@ Line 281: / Line 295: @@
-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 Token]]** 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>
 \\

Differences

Worldnet

Learn More

Request

Contact Us