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 [2020/03/05 11:07]
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.| | 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]]**. |
-| 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>​ </​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** ^ ^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^
Line 135: Line 136:
 **ND008 - Stored Credential use field behavior and settings** **ND008 - Stored Credential use field behavior and settings**
  
-This feature is currently available to TSYS Saratoga terminals. ​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:
- +
-The COF tags are required for the following usage:+
   * • Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway).   * • 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 ==== ==== Examples for a Request ====
Line 237: Line 248:
 </​WRAP>​ </​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%> <WRAP center box 100%>
Line 251: Line 262:
 </​WRAP>​ </​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%> <WRAP center box 100%>
Line 270: 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: card data used for the transaction. In this case, the following extra parameter are going to be added to the response body:
  
Line 284: 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.
  
  
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International