Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
developer:api_specification:hpp_payment_features [2019/06/04 14:40]
vinayh [Notes and Details on the Response]
developer:api_specification:hpp_payment_features [2020/03/13 17:49] (current)
robinc [Notes and Details About the Request]
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.| | 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]]**. | | 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]]**. |
-OTHERFIELD ​| N | Any other fields sent in the request will be treated as a custom ​field. ​They are not going to be storedbut they are going to be used by the Payment Gateway for the request sent to the Receipt URLNote that this is subject to the max length of a HTTP GET request which we would conservatively recommend considering to be 2000 characters. |+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  |UNSCHEDULEDINSTALLMENT or RECURRRINGSee note **ND008 - 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**. | 
 </​searchtable>​ </​searchtable>​
  
Line 83: Line 86:
 **ND001 - Hash Formation** **ND001 - Hash Formation**
  
-The gerenal ​rule to build HASH field is given at the **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]** page. For this specific feature, you should use the following formats:+The general ​rule to build HASH field is given at the **[[developer:​api_specification:​special_fields_and_parameters|Special Fields and Parameters]]** page. For this specific feature, you should use the following formats:
  
 When using a Single Currency Terminal, the string to generate the HASH field is going to formed using: When using a Single Currency Terminal, the string to generate the HASH field is going to formed using:
Line 127: Line 130:
  
 Depending on your customer'​s browser definitions and if there'​s a language template defined for his/ her language priority, the Payment Gateway is going to send the payment receipt translated. If the language is not supported by the gateway, the receipt is going to be sent using the gateway'​s language. Depending on your customer'​s browser definitions and if there'​s a language template defined for his/ her language priority, the Payment Gateway is going to send the payment receipt translated. If the language is not supported by the gateway, the receipt is going to be sent using the gateway'​s language.
 +
 +\\
 +
 +**ND008 - Stored Credential use field behavior and settings**
 +
 +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. |
 +
 +
  
  
Line 207: Line 228:
 | CUSTOMFIELD | Same as informed at the transaction'​s request. Returns all custom fields informed on request. | | CUSTOMFIELD | Same as informed at the transaction'​s request. Returns all custom fields informed on request. |
 | OTHERFIELD | Same as informed at the transaction'​s request. Returns all additional fields informed on request. | | OTHERFIELD | Same as informed at the transaction'​s request. Returns all additional fields informed on request. |
 +| BRANDTXIDENTIFIER | Same as informed at the transaction'​s request. Returned if informed on request. |
 +| STOREDCREDENTIALUSE | Same as informed at the transaction'​s request. Returned if informed on request. |
 +| STOREDCREDENTIALTXTYPE | Same as informed at the transaction'​s request. Returned if informed on request. |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 244: Line 268:
 \\ \\
  
-**ND002 - Sentinel Defend ​Enabling**+**ND002 - Fraud Solution ​Enabling**
  
-Sentinel Defend ​must be enabled for your Gateway and on the Terminal used for processing the transaction request so that the response contains those fields.+Fraud Solution ​must be enabled for your Gateway and on the Terminal used for processing the transaction request so that the response contains those fields.
  
 \\ \\
  
-**ND003 - Sentinel Defend ​REVIEW status**+**ND003 - Fraud Solution ​REVIEW status**
  
 If a transaction is returned with "​FRAUDREVIEWSTATUS"​ as "​REVIEW",​ this transaction can be changed manually, using the new report feature on Selfcare System, or using the transaction update XML gateway service, to "​APPROVE"​ or "​REJECT"​ the transaction. Transactions with this status are not going to be settled until the transaction status is changed. See the XML Gateway method for more details, more specifically,​ its **Transaction Update** feature, to change the transaction returned as "​REVIEW"​ to "​REJECT"​ or "​APPROVE"​. If a transaction is returned with "​FRAUDREVIEWSTATUS"​ as "​REVIEW",​ this transaction can be changed manually, using the new report feature on Selfcare System, or using the transaction update XML gateway service, to "​APPROVE"​ or "​REJECT"​ the transaction. Transactions with this status are not going to be settled until the transaction status is changed. See the XML Gateway method for more details, more specifically,​ its **Transaction Update** feature, to change the transaction returned as "​REVIEW"​ to "​REJECT"​ or "​APPROVE"​.
Line 272: Line 296:
 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>​
 \\ \\
  
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International