--- developer:api_specification:xml_payment_features [2020/01/17 13:32]
vinayh [Notes and Details About the Request]
+++ developer:api_specification:xml_payment_features [2022/03/04 11:30]
lezlieh edits for secure token
@@ Line 31: / Line 31: @@
 | DATETIME |  Y  | Request date and time. Format: DD-MM-YYY:HH:MM:SS:SSS.|
 | TRACKDATA	|	N	| Track 2 data.\\ Should be present for a swiped cardholder present (CHP) transaction. If this is present then TERMINALTYPE should be set to 3 and TRANSACTIONTYPE should be set to 0.	|
-| CARDNUMBER	|	N	| Payment card number.\\ Required if TRACKDATA is not being sent.\\ If a SECURECARD is used (in CARDTYPE), this field should inform the CARDREFERENCE of the given Secure Card. |
+| CARDNUMBER	|	N	| Payment card number.\\ Required if TRACKDATA is not being sent.\\ If a SECURECARD is used (in CARDTYPE), this field should inform the CARDREFERENCE of the given Secure Token. |
 | GOOGLEPAYLOAD |	N	| When using google pay for payments, instead of the TRACKDATA or CARDNUMBER, you pass this field, with the Google Pay user data, received from your request, converted to Hexadecimal. |
 | APPLEPAYLOAD |	N	| When using apple pay for payments, instead of the TRACKDATA or CARDNUMBER, you pass this field, with the Apple Pay user data, received from your request, converted to Hexadecimal. |
-| CARDTYPE	|	Y	| Card Type used for the transaction.\\ For more details on this, visit **[[developer:api_specification:special_fields_and_parameters#the_card_types|Special Fields and Parameters - Card Types]]**.\\ This field can also admit the SECURECARD type, when using a Secure Card to perform the transaction. |
+| CARDTYPE	|	Y	| Card Type used for the transaction.\\ For more details on this, visit **[[developer:api_specification:special_fields_and_parameters#the_card_types|Special Fields and Parameters - Card Types]]**.\\ This field can also admit the SECURECARD type, when using a Secure Token to perform the transaction. |
 | CARDEXPIRY	|	N	| Expiry date of the card.\\ A 4 digit expiry field (MMYY), required if TRACKDATA is not being sent.\\ This field should not be informed if the CARDTYPE is SECURECARD. |
 | CARDHOLDERNAME	|	N	| The name of the card holder, required if TRACKDATA is not being sent and not using a SecureCard. It should be as displayed on the front of the card.\\ This field should not be informed if the CARDTYPE is SECURECARD. |
@@ Line 69: / Line 69: @@
 | FRAUDREVIEWSESSIONID	|	N	| This field should contain the value of THEIR_SESSION_ID parameter that a merchant integration uses to configure its session with Fraud Solution. See the **ND003 - Using Fraud Solution**, in the next section.	|
 | CREDENTIALONFILE	|	N	| Component of the request that can be added in case Credential on File feature is in use for the Terminal processing the Payment. See **ND008 - Credential on File**.	|
+| 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 313: / Line 314: @@
 **ND008 - Credential on File**
-This feature is currently available to TSYS Saratoga terminals.
+This feature is currently available to TSYS Saratoga terminals. The COF tags are required for the following usage:
-Two usages:
-  *   * Processing transaction with Secure Card (stored in Nuvei Gateway) but using the same Secure Card for different usage.
   *   * Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway).
-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 add them to the transaction, but does not show it to the customer.
+The fields will have the following behavior: Hidden - the gateway accepts the fields, if sent, and add them to the transaction, but does not show it to the customer.
 To provide a transaction with COF, your request needs to add the Credential on File component and its fields, as described below.
@@ Line 681: / Line 679: @@
 **ND008 - Credential on File**
-This feature is currently available to TSYS Saratoga terminals.
+This feature is currently available to TSYS Saratoga terminals. The COF tags are required for the following usage:
-Two usages:
-  *   * Processing transaction with Secure Card (stored in Nuvei Gateway) but using the same Secure Card for different usage.
   *   * Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway).
-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.
+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.
 (new table below note ND008)
@@ Line 1073: / Line 1068: @@
 **ND008 - Credential on File**
-This feature is current available to TSYS Saratoga terminals.
+This feature is current available to TSYS Saratoga terminals. The COF tags are required for the following usage:
-Two usages:
-  *   * Processing transaction with Secure Card (stored in Nuvei Gateway) but using the same Secure Card for different usage.
   *   * Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway)
-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, if sent, and adds them to the transaction, but does not show it for the customer.
+The fields will have the following behavior: Hidden - the gateway accepts, 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 Credentials on File component and its fields, as described below.
@@ Line 1833: / Line 1825: @@
 | CARDREFERENCE	|	N	| Secure Card reference generated and returned by the Payment Gateway when created. Either CARDREFERENCE or CARDETAILS should be used on request, never both. |
 | CARDDETAILS   |	N	| Details of the card to which the refund is going to be done to. Take a look at **ND003 - Card Details** to see this tag's subelements. Either CARDREFERENCE or CARDETAILS should be used on request, never both. |
+| DECLINEDREFUNDUNIQUEREF	|	N	| In the case where the merchant is performing an Unreferenced Refund and linking it to a Declined Online Refund.This tag must be included when the terminal uses UNIQUEREF. The card specified for this Unreferenced Refund must be different than that of the original Declined Refund.	|
+| DECLINEDREFUNDORDERID	|	N	| In the case where the merchant is performing an Unreferenced Refund and linking it to a Declined Online Refund. - This tag must be included when the terminal does NOT use UNIQUEREF. - If this tag is provided when a terminal specifically uses UNIQUEREF, an error will be returned. - The card specified for this Unreferenced Refund must be different than that of the original Declined Refund.	|
 | AMOUNT	|	Y	| The amount of the transaction. A 2 digit decimal or an Integer value for JPY amounts.	|
 | AUTOREADY	|	N	| Y or N. If this is set to Y, Nuvei will automatically set the transaction to READY in the batch. If set to N then the transaction will go to a PENDING status. If not present, the terminal default will be used.	|
@@ Line 2411: / Line 2405: @@
 <searchtable>
 ^ 	**FIELD**	^	**REQUIRED**	^	**DESCRIPTION**	^
-| TERMINALID	|	Y	| A Terminal ID provided by %CompanyName. NB - Please contact %CompanyName to be issued with a test terminal ID.	|
+| TERMINALID	|	Y	| A Terminal ID provided by Nuvei. NB - Please contact Nuvei to be issued with a test terminal ID.	|
-| UNIQUEREF 	|	Y	| Refers the UNIQUEREF generate for the original transaction response. |
+| UNIQUEREF 	|	Y/N	| Refers the UNIQUEREF generated for the original transaction response. The field is required when ORDERID is omitted from the request. |
+| ORDERID 	|	Y/N	| Required with UNIQUEREF is not populated. A search can be made using the ORDERID of the transaction. This requires the target terminal to have the setting 'Force Unique Order ID' enabled. |
 | DATETIME		|	Y	| Request date and time. Format: DD-MM-YYYY:HH:MM:SS:SSS.	|
 | HASH			| 	Y	| A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**, in the next section.	|
@@ Line 2424: / Line 2419: @@
 The general rule to build the HASH field is given on the **[[developer:api_specification:special_fields_and_parameters|Special Fields and Parameters]]** page, under the **[[developer:api_specification:special_fields_and_parameters#the_hash_parameter|Special Fields and Parameters]]** section. For this specific feature, you should use the following formats:
+**When using UNIQUEREF**
 <WRAP center box 100%>
 TERMINALID:UNIQUEREF:DATETIME:SECRET
+</WRAP>
+**When using ORDERID**
+<WRAP center box 100%>
+TERMINALID:ORDERID:DATETIME:SECRET
 </WRAP>
@@ Line 2451: / Line 2452: @@
 </code>
+<code xml>
+<?xml version="1.0" encoding="UTF-8"?>
+<GET_TRANSACTION_DETAILS>
+    <TERMINALID>6491002</TERMINALID>
+    <ORDERID>GCNQAWUUVZ</ORDERID>
+    <DATETIME>06-03-2018:17:41:08:273</DATETIME>
+    <HASH>73e340cfb2b7424252d1ced917e4f74704aaa66a9600039f4800434cefe87d721c342d2b915c6e2aeea88b34e749ba97665f7d9e50b1144ca0f0745361fc4896</HASH>
+</GET_TRANSACTION_DETAILS>
+</code>
 \\
 ==== Response Body Fields ====
@@ Line 2490: / Line 2500: @@
 <WRAP center box 100%>
-TERMINALID:UNIQUEREF:ORDERID:TRANSACTION_STATUS:TRANSACTION_DATE:OPERATOR:TRANSACTION_TYPE:CURRENCY:AUTHORIZEDAMOUNT:BATCH_NUMBER:BULK_NUMBER:PROCESSINGTERMINAL:RESPONSECODE:RESPONSETEXT:APPROVALCODE:CARDCURRENCY:CARDAMOUNT:CONVERSIONRATE:DESCRIPTION:DATETIME:SECRET
+TERMINALID:UNIQUEREF:TRANSACTION_STATUS:TRANSACTION_DATE:OPERATOR:TRANSACTION_TYPE:CURRENCY:AUTHORIZEDAMOUNT:BATCH_NUMBER:BULK_NUMBER:PROCESSINGTERMINAL:RESPONSECODE:RESPONSETEXT:APPROVALCODE:CARDCURRENCY:CARDAMOUNT:CONVERSIONRATE:DESCRIPTION:DATETIME:SECRET
 </WRAP>

Differences

Worldnet

Learn More

Request

Contact Us