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:xml_payment_features [2019/10/23 16:34]
robinc [Response Body Fields] removed ORDERID as a Response Body Field per Jason Oliver VS 57841
developer:api_specification:xml_payment_features [2020/04/06 13:31] (current)
robinc [Request Body Fields] added decline refund fields
Line 68: Line 68:
 | ENHANCED_DATA_TEMPLATE |  N  | Enhanced Data template name to be used when creating the transaction. It fills up any not provided transaction'​s enhanced data fields. \\ Note that if you use a template, but inform the data during the request, the gateway is just going to use the template to fill the gaps of whatever you didn't inform in your original request. Also, if you inform at least one item in LEVEL_3_DATA component, no item from the template is going to be applied. \\ This field should only be used if you desire to use one of your Enhanced Data Templates (see **[[merchant:​existing_merchant:​selfcare_system:​settings:​enhanced_data_templates|Enhanced Data Templates]]** for more details). \\ This field is only available for terminals with ** Transaction Enhanced Data** feature enabled. | | ENHANCED_DATA_TEMPLATE |  N  | Enhanced Data template name to be used when creating the transaction. It fills up any not provided transaction'​s enhanced data fields. \\ Note that if you use a template, but inform the data during the request, the gateway is just going to use the template to fill the gaps of whatever you didn't inform in your original request. Also, if you inform at least one item in LEVEL_3_DATA component, no item from the template is going to be applied. \\ This field should only be used if you desire to use one of your Enhanced Data Templates (see **[[merchant:​existing_merchant:​selfcare_system:​settings:​enhanced_data_templates|Enhanced Data Templates]]** for more details). \\ This field is only available for terminals with ** Transaction Enhanced Data** feature enabled. |
 | 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**. |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 310: Line 310:
 \\ \\
  
 +
 +**ND008 - Credential on File**
 +
 +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 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.
 +
 +(new table below note ND008)
 +
 +^ **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. |
 +
 +\\
 +Quick example:
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​PAYMENT>​
 +<​ORDERID>​CSV_99769707</​ORDERID>​
 +<​TERMINALID>​2366006</​TERMINALID>​
 +<​AMOUNT>​6.00</​AMOUNT>​
 +<​DATETIME>​11-09-2019:​14:​02:​49:​708</​DATETIME>​
 +<​CARDNUMBER>​4444333322221111</​CARDNUMBER>​
 +<​CARDTYPE>​VISA</​CARDTYPE>​
 +<​CARDEXPIRY>​1224</​CARDEXPIRY>​
 +<​CARDHOLDERNAME>​na</​CARDHOLDERNAME>​
 +<​HASH>​f048c44d0340af522d5796110675fb1a</​HASH>​
 +<​CURRENCY>​USD</​CURRENCY>​
 +<​TERMINALTYPE>​1</​TERMINALTYPE>​
 +<​TRANSACTIONTYPE>​1</​TRANSACTIONTYPE>​
 +<​AUTOREADY>​Y</​AUTOREADY>​
 +<​CVV>​123</​CVV>​
 +<​ADDRESS1>​ads</​ADDRESS1>​
 +<​ADDRESS2>​ads2</​ADDRESS2>​
 +<​POSTCODE>​123</​POSTCODE>​
 +<​CREDENTIALONFILE>​
 +<​ORIGINALBRANDTXIDENTIFIER>​1234567890</​ORIGINALBRANDTXIDENTIFIER>​
 +<​STOREDCREDENTIALTXTYPE>​SUBSEQUENT_MERCHANT_INITIATED_TXN</​STOREDCREDENTIALTXTYPE>​
 +<​STOREDCREDENTIALUSE>​UNSCHEDULED</​STOREDCREDENTIALUSE>​
 +</​CREDENTIALONFILE>​
 +</​PAYMENT>​
 +</​code>​
 ==== Response Body Fields ==== ==== Response Body Fields ====
  
Line 325: Line 372:
 | CVVRESPONSE ​        | The result of the CVV check. Check **[[merchant:​existing_merchant:​other_information:​transaction_responses|Transaction Responses]]**. | | CVVRESPONSE ​        | The result of the CVV check. Check **[[merchant:​existing_merchant:​other_information:​transaction_responses|Transaction Responses]]**. |
 | PROCESSINGTERMINAL ​ | If the transaction was performed on a "​routing terminal"​ then this is populated with processing terminal ID that the system selected to process the transaction.| | PROCESSINGTERMINAL ​ | If the transaction was performed on a "​routing terminal"​ then this is populated with processing terminal ID that the system selected to process the transaction.|
-| FRAUDREVIEWRESPONSE | Component of the response that is going to be added in case the Threat Metrix feature is in use for the Terminal processing the Payment. See **ND002 - ThreatMetrix ​Response** for more details. | +| FRAUDREVIEWRESPONSE | Component of the response that is going to be added in case the Threat Metrix feature is in use for the Terminal processing the Payment. See **ND002 - Fraud Solution ​Response** for more details. | 
 | ADDITIONAL_FIELD | This field is used to send back data of interest of the merchant received by the gateway during the transaction. See **ND003 - Additional Information on Response**| | ADDITIONAL_FIELD | This field is used to send back data of interest of the merchant received by the gateway during the transaction. See **ND003 - Additional Information on Response**|
 | CARDREFERENCE | This field represents the token generated for the Secure Card. It's going to be returned when the Settings related to this payment enable the automatic generation of Secure Cards within a Payment. Take a look at **ND004 - Secure Card Auto Registration**. | | CARDREFERENCE | This field represents the token generated for the Secure Card. It's going to be returned when the Settings related to this payment enable the automatic generation of Secure Cards within a Payment. Take a look at **ND004 - Secure Card Auto Registration**. |
Line 331: Line 378:
 | DATETIME | Response date and time for the transaction,​ created by the bank. Format: YYYY-MM-DDTHH:​MM:​SS. Note that this is intentionally in a different format to the request timestamp to highlight the fact that it is a different time.| | DATETIME | Response date and time for the transaction,​ created by the bank. Format: YYYY-MM-DDTHH:​MM:​SS. Note that this is intentionally in a different format to the request timestamp to highlight the fact that it is a different time.|
 | HASH | 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 | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. |
 +| BRANDTXIDENTIFIER | The gateway returns the transaction identifier received from Acquirer to the merchant in the response if Credential on File is used. |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 474: Line 522:
 | ENHANCED_DATA_TEMPLATE |  N  | Enhanced Data template name to be used when creating the transaction. It fills up any not provided transaction'​s enhanced data fields. \\ Note that if you use a template, but inform the data during the request, the gateway is just going to use the template to fill the gaps of whatever you didn't inform in your original request. Also, if you inform at least one item in LEVEL_3_DATA component, no item from the template is going to be applied. \\ This field should only be used if you desire to use one of your Enhanced Data Templates (see **[[merchant:​existing_merchant:​selfcare_system:​settings:​enhanced_data_templates|Enhanced Data Templates]]** for more details.) \\ This field is only available for terminals with **Transaction Enhanced Data** feature enabled. | | ENHANCED_DATA_TEMPLATE |  N  | Enhanced Data template name to be used when creating the transaction. It fills up any not provided transaction'​s enhanced data fields. \\ Note that if you use a template, but inform the data during the request, the gateway is just going to use the template to fill the gaps of whatever you didn't inform in your original request. Also, if you inform at least one item in LEVEL_3_DATA component, no item from the template is going to be applied. \\ This field should only be used if you desire to use one of your Enhanced Data Templates (see **[[merchant:​existing_merchant:​selfcare_system:​settings:​enhanced_data_templates|Enhanced Data Templates]]** for more details.) \\ This field is only available for terminals with **Transaction Enhanced Data** feature enabled. |
 | APPROVALCODE | Y | Approval code provided by the Acquirer for the specific transaction | | APPROVALCODE | Y | Approval code provided by the Acquirer for the specific transaction |
 +| CREDENTIALONFILE | Y | 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**. |
  
 </​searchtable>​ </​searchtable>​
Line 628: Line 676:
 \\ \\
  
-==== Examples for a Request ====+**ND008 - Credential on File**
  
-  * **Scenario**:​ Simple request, only mandatory fields. +This feature is currently available to TSYS Saratoga terminalsThe COF tags are required for the following usage
-  * **Terminal**6491002. +  *   ​Processing transaction in clear card but token vaulted externally (outside Nuvei Gateway).
-  * **Terminal Secret**: x4n35c32RT.+
  
-<code xml> +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.
-<?xml version="​1.0" encoding="​UTF-8"?>​ +
-<​OFFLINEPAYMENT>​ +
- <​ORDERID>​115010922465</​ORDERID>​ +
- <​TERMINALID>​6491002</​TERMINALID>​ +
- <​AMOUNT>​10</​AMOUNT>​ +
- <​CARDNUMBER>​4111111111111111</​CARDNUMBER>​ +
- <​CARDTYPE>​VISA</​CARDTYPE>​ +
- <​CARDEXPIRY>​0807</​CARDEXPIRY>​ +
- <​CARDHOLDERNAME>​Joe Bloggs</​CARDHOLDERNAME>​ +
- <​CURRENCY>​EUR</​CURRENCY>​ +
- <​TERMINALTYPE>​1</​TERMINALTYPE>​ +
- <​TRANSACTIONTYPE>​7</​TRANSACTIONTYPE>​ +
- <​APPROVALCODE>​DSIC234Fsdsfc35</​APPROVALCODE>​ +
- <​DATETIME>​12-06-2006:​11:​47:​04:​656</​DATETIME>​ +
- <​HASH>​33e51227ab83222cea0cc1f03532149319dae3ab8839ad278a82b16d0d15d49bec9e90df00b6504564e3075cb3d984e21471469315526f376a256c557b175a07</​HASH>​ +
-</​PAYMENT>​ +
-</​code>​ +
-\\+
  
-<WRAP center important 100%> +(new table below note ND008) 
-**REMEMBER** to change the Terminal ID and Terminal Secret for valid values. Consult the **[[developer:​integration_docs|Integration Docs]]** for examples or contact our support team+ 
-</​WRAP>​+**FIELD** **REQUIRED** ^ **DESCRIPTION** ^ 
 +| ORIGNALBRANDIXIDENTIFIER | 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_INITIATED_TXN | 
 +| STOREDCREDENTIALUSE | N | Possible values: UNSCHEDULED,​ INSTALLMENT or RECURRING |
  
 \\ \\
Line 678: Line 710:
 | DATETIME | Response date and time for the transaction,​ created by the bank. Format: YYYY-MM-DDTHH:​MM:​SS. Note that this is intentionally in a different format to the request timestamp to highlight the fact that it is a different time.| | DATETIME | Response date and time for the transaction,​ created by the bank. Format: YYYY-MM-DDTHH:​MM:​SS. Note that this is intentionally in a different format to the request timestamp to highlight the fact that it is a different time.|
 | HASH | 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 | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. |
 +| BRANDTXIDENTIFIER | The gateway returns the transaction identifier received from Acquirer to the merchant in the response if Credential on File is used. |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 804: Line 837:
 | 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. |
 +| 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**.|
 </​searchtable>​ </​searchtable>​
  
Line 1030: Line 1064:
 </​code>​ </​code>​
  
 +\\
 +**ND008 - Credential on File**
 +
 +This feature is current 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, 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.
 +
 +
 +<​searchtable>​
 +^ **FIELD** ^ **REQUIRED** ^ **DESCRIPTION** ^
 +| ORIGINALBRANDTXIDENTIFIER | N | String, max length is 64, Merchant send the transaction if received from acquirer.|
 +| STOREDCREDENTIALTXTYPE | N | Possible values: FIRST_TXN, SUBSEQUENT_MERCHANT_INITIATED_TXN or SUBSEQUENT_CARDHOLDER_INITIATED_TXN |
 +| STOREDCREDENTIALUSE | N | Possible values: UNSCHEDULED,​ INSTALLMENT or RECURRING |
 +</​searchtable>​
 \\ \\
  
Line 1035: Line 1086:
 **REMEMBER** to change the Terminal ID and Terminal Secret for valid values. Consult the **[[developer:​integration_docs|Integration Docs]]** for examples or contact our support team. **REMEMBER** to change the Terminal ID and Terminal Secret for valid values. Consult the **[[developer:​integration_docs|Integration Docs]]** for examples or contact our support team.
 </​WRAP>​ </​WRAP>​
- 
 \\ \\
 +Quick Example:
  
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​PAYMENT>​
 +<​ORDERID>​CSV_99769707</​ORDERID>​
 +<​TERMINALID>​2366006</​TERMINALID>​
 +<​AMOUNT>​6.00</​AMOUNT>​
 +<​DATETIME>​11-09-2019:​14:​02:​49:​708</​DATETIME>​
 +<​CARDNUMBER>​4444333322221111</​CARDNUMBER>​
 +<​CARDTYPE>​VISA</​CARDTYPE>​
 +<​CARDEXPIRY>​1224</​CARDEXPIRY>​
 +<​CARDHOLDERNAME>​na</​CARDHOLDERNAME>​
 +<​HASH>​f048c44d0340af522d5796110675fb1a</​HASH>​
 +<​CURRENCY>​USD</​CURRENCY>​
 +<​TERMINALTYPE>​1</​TERMINALTYPE>​
 +<​TRANSACTIONTYPE>​1</​TRANSACTIONTYPE>​
 +<​AUTOREADY>​Y</​AUTOREADY>​
 +<​CVV>​123</​CVV>​
 +<​ADDRESS1>​ads</​ADDRESS1>​
 +<​ADDRESS2>​ads2</​ADDRESS2>​
 +<​POSTCODE>​123</​POSTCODE>​
 +<​CREDENTIALONFILE>​
 +<​ORIGINALBRANDTXIDENTIFIER>​1234567890</​ORIGINALBRANDTXIDENTIFIER>​
 +<​STOREDCREDENTIALTXTYPE>​SUBSEQUENT_MERCHANT_INITIATED_TXN</​STOREDCREDENTIALTXTYPE>​
 +<​STOREDCREDENTIALUSE>​UNSCHEDULED</​STOREDCREDENTIALUSE>​
 +</​CREDENTIALONFILE>​
 +</​PAYMENT>​
 +</​code>​
 ==== Response Body Fields ==== ==== Response Body Fields ====
  
Line 1058: Line 1136:
 | DATETIME | Response date and time for the transaction,​ created by the bank. Format: YYYY-MM-DDTHH:​MM:​SS. Note that this is intentionally in a different format to the request timestamp to highlight the fact that it is a different time.| | DATETIME | Response date and time for the transaction,​ created by the bank. Format: YYYY-MM-DDTHH:​MM:​SS. Note that this is intentionally in a different format to the request timestamp to highlight the fact that it is a different time.|
 | HASH | 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 | A HASH code formed by part of the request fields. The formation rule is given at the **ND001 - Hash Formation**,​ in the next section. |
 +| BRANDTXIDENTIFIER | The gateway returns the transaction identifier received from Acquirer to the merchant in the response if Credential on File is used. |
 </​searchtable>​ </​searchtable>​
 \\ \\
Line 1745: Line 1824:
 | 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. |
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International