This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
developer:api_specification:xml_payment_features [2020/01/17 13:32] vinayh [Notes and Details About the Request] |
developer:api_specification:xml_payment_features [2021/04/13 13:13] robinc [Notes and Details About the Request] added ORDERID format |
||
---|---|---|---|
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. | | | 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**. | | | 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> | </searchtable> | ||
\\ | \\ | ||
Line 313: | Line 314: | ||
**ND008 - Credential on File** | **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). | * * 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. | 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** | **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). | * * 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) | (new table below note ND008) | ||
Line 1073: | Line 1068: | ||
**ND008 - Credential on File** | **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) | * * 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. | 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. | | | 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. | | | 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. | | | 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. | | | 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> | <searchtable> | ||
^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^ | ^ **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. | | | 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. | | | 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: | 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%> | <WRAP center box 100%> | ||
TERMINALID:UNIQUEREF:DATETIME:SECRET | TERMINALID:UNIQUEREF:DATETIME:SECRET | ||
+ | </WRAP> | ||
+ | **When using ORDERID** | ||
+ | <WRAP center box 100%> | ||
+ | TERMINALID:ORDERID:DATETIME:SECRET | ||
</WRAP> | </WRAP> | ||