XML Payment Features

In this feature you can find many different subfeatures which are used to create and manage the transactions performed by merchants' terminals. They are useful in a scenario where your application needs full control of the payment process.

The following resources are the same for all the requests and responses you find on this page:

Use the Request URL and the Request Body Fields to perform a request for this feature, then prepare your integration to receive the response, as defined by the Response Body Fields.

This feature allows you to perform payments.

• Main Request body Tag: <PAYMENT>
• Main Response body Tag: <PAYMENTRESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. 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 be formed using:

When using a Multi Currency Terminal, the string to generate the HASH field is going to formed using:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Using Fraud Solution

If a merchant wishes to use Fraud Solution on its website, it must insert the Fraud Solution scripts to its website. These scripts create a profile on Fraud Solution servers and are used to validate the user's device..

<!-- Fraud Solution Profiling Tags -->
<script type="text/javascript" src="https://h.online-metrix.net/fp/tags.js?org_id=THEIR_ORD_ID&session_id=THEIR_SESSION_ID&pageid=PAGEID"></script>
<noscript>
    <iframe style="width: 100px; height: 100px; border: 0; position: absolute; top: -5000px;" src="https://h.online-metrix.net/fp/tags.js?org_id=THEIR_ORG_ID&session_id=THEIR_SESSION_ID&pageid=PAGEID"></iframe>
</noscript>

The parameters THEIR_ORG_ID and THEIR_SESSION_ID must be supplied by the merchant.

ND004 - Using eDCC

All eDCC enabled XML requests must include the FOREIGNCURRENCYINFORMATION tag and its nested tags.

Those fields can be obtained by using the eDCC Exchange Rate feature.

ND005 - Level II Data Validation

This field is associated with the Transaction Enhanced Data feature. “Allow Enhancced Data (Level II and Level III)” must be enabled with the “Transaction Data Level” option set as “Level II” on the Processing Terminal “Features” section.

To provide a transaction with LEVEL 2, your request needs to add the LEVEL_2_DATA component and its fields, as described below.

Quick example:

<LEVEL_2_DATA>
    <CUSTOMER_REF_NUMBER>SDGK-JSAAS-0235.00002314</CUSTOMER_REF_NUMBER>
    <TAX_AMOUNT>151.27</TAX_AMOUNT>
    <SHIPPING_ADDRESS>
              <FULL_NAME>JOHN SMITH AND ASSOCIATES<FULL_NAME>
              <ADDRESS1>Unit 001, Street X</ADDRESS1>
              <ADDRESS2>Block "A", Neighborhood "A"</ADDRESS2>
              <CITY>City "Y"</CITY>
              <REGION>Region 1 </REGION>
              <POSTCODE>A00B0001</POSTCODE>
              <COUNTRY>Country "Z"</COUNTRY>
    </SHIPPING_ADDRESS>
</LEVEL_2_DATA>

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.

Quick Example

<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>

ND007 - Multi Language Support

In case you desire to inform your customer's email and desire to provide his/ her receipt in another language, you can use the Accept-Language parameter of the request to set language the customer should receive the receipt in. If the language informed is not supported, the Payment Gateway will use its default language (EN). Possible values are 'fr-FR' or even 'fr,en-US;q=0.9,en;q=0.8,ru;q=0.7,de;q=0.6,ru-RU;q=0.5,de-DE;q=0.4'.

• Scenario: Simple request, only mandatory fields.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<PAYMENT>
	<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>
	<CVV>214</CVV>
	<DATETIME>12-06-2006:11:47:04:656</DATETIME>
	<HASH>d04c3bab519095ecb046eff91722e8df</HASH>
</PAYMENT>

• Scenario: Payment using eDCC, only mandatory fields.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<PAYMENT>
	<ORDERID>1150109224656</ORDERID>
	<TERMINALID>6491002</TERMINALID>
	<AMOUNT>10</AMOUNT>
	<DATETIME>12-06-2006:11:47:04:656</DATETIME>
	<CARDNUMBER>4111111111111111</CARDNUMBER>
	<CARDTYPE>VISA</CARDTYPE>
	<CARDEXPIRY>0807</CARDEXPIRY>
	<CARDHOLDERNAME>Joe Bloggs</CARDHOLDERNAME>
	<HASH>d04c3bab519095ecb046eff91722e8df</HASH>
	<CURRENCY>EUR</CURRENCY>
	<FOREIGNCURRENCYINFORMATION>
		<CARDCURRENCY>GBP</CARDCURRENCY>
		<CARDAMOUNT>6.67</CARDAMOUNT>
		<CONVERSIONRATE>0.667157</CONVERSIONRATE>
	</FOREIGNCURRENCYINFORMATION>
	<TERMINALTYPE>1</TERMINALTYPE>
	<TRANSACTIONTYPE>7</TRANSACTIONTYPE>
	<CVV>214</CVV>
</PAYMENT>  

The response body fields will be:

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. 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 be formed using:

When using a Multi Currency Terminal, the string to generate the HASH field is going to formed using:

ND002 - Fraud Solution Response

In case the request of a transaction required the Fraud Solution verification, and the Terminal allowed, the result is then sent back in the FRAUDREVIEWRESPONSE field with the following subelements:

The response component FRAUDREVIEWRESPONSE would look like this inside the response body:

<FRAUDREVIEWRESPONSE>
    <FRAUDREVIEWSTATUS>PASS</FRAUDREVIEWSTATUS>
    <FRAUDREVIEWRISKRATING>LOW</FRAUDREVIEWRISKRATING>
    <FRAUDREVIEWSCORE>-10</FRAUDREVIEWSCORE>
    <FRAUDREVIEWREASONCODE>Profiling Blocked,Profiling Incomplete</FRAUDREVIEWREASONCODE>
</FRAUDREVIEWRESPONSE>

If a transaction is returned with “FRAUDREVIEWSTATUS” or “REVIEW”, this transaction can be changed to “APPROVE” or “REJECT”. For that, you have two options: let your users do that on the SelfCare System, using the new report feature or,through integration, they can use the Transaction Status Update feature, present on this page. Attention to those transactions which stay as “REVIEW”: they are not going to be settled until the transaction status is changed to “APPROVE” or “REJECT”. So, take a look at the Transaction Status Updatee or remind your users to review the transactions constantly/regularly.

ND003 - Additional Information on Response

This data is going to be sent back only when the Terminal executing the transaction is configured to do so. This configuration can be activated on the Terminal settings by enabling the “Integration” option “Enable original response in XML”. Currently two possible fields can be returned: ACQUIRER_RESPONSE_CODE and ACQUIRER_RESPONSE_TEXT, containing the original code and text from the acquirer's response to the authorization transaction.

ND004 - Secure Card Auto Registration

This field is returned when a secure card is created based on the card data passed in the request. This is only going to happen when the settings on Merchant Portfolio and Terminal align to allow the auto creation and storage of Secure Cards, and the request in place sends the details for a Secure Card (no TRACKDATA). If you are curious and want to know more about the settings, visit the | Important Integration Settings page.

ND005 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

• Scenario: Response to the initial simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<PAYMENTRESPONSE>
	<UNIQUEREF>JJCVGCTOV3</UNIQUEREF>
	<RESPONSECODE>A</RESPONSECODE>
	<RESPONSETEXT>APPROVAL</RESPONSETEXT>
	<APPROVALCODE>475318</APPROVALCODE>
	<DATETIME>2005-11-14T12:53:18</DATETIME>
	<CVVRESPONSE>M</CVVRESPONSE>
	<HASH>afe4c8b57f3ea0dfee7c8f75fae7e90d</HASH>
</PAYMENTRESPONSE> 

This feature allows you to perform payments.

• Main Request body Tag: <OFFLINEPAYMENT>
• Main Response body Tag: <OFFLINEPAYMENTRESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. 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 be formed using:

When using a Multi Currency Terminal, the string to generate the HASH field is going to formed using:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Using eDCC

All eDCC enabled XML requests must include the FOREIGNCURRENCYINFORMATION tag and its nested tags.

Those fields can be obtained by using the eDCC Exchange Rate feature.
ND004 - Level II 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 II” on the Processing Terminal “Features” section.

This field is associated with the feature “Level II Data”, and to be used it is necessary to set the “Allow Level II Data” option on the Processing Terminal “Features” section.

To provide a transaction with Level 2, your request needs to add the LEVEL_2_DATA component and its fields, as described below.

Quick example:

<LEVEL_2_DATA>
     <CUSTOMER_REF_NUMBER>SDGK-JSAAS-0235.00002314</CUSTOMER_REF_NUMBER>
     <TAX_AMOUNT>151.27</TAX_AMOUNT>
     <SHIPPING_ADDRESS>
          <FULL_NAME>JOHN SMITH AND ASSOCIATES</FULL_NAME>
          <ADDRESS1>UNIT 001, Street X</ADDRESS1>
          <ADDRESS2>Block "A", Neighborhood "A"</ADDRESS2>
          <CITY>City "Y"</CITY>
          <REGION>Region 1</REGION>
          <POSTCODE>A00B0001</POSTCODE>
          <COUNTRY>Country "Z"</COUNTRY>
     </SHIPPING_ADDRESS>
</LEVEL_2_DATA>

ND005 - Level 3 Data Validation This field is associated with the Transaction Enhanced Data feauture.“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.

Quick example:

<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>
               <COMMODITYCODE>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>

• Scenario: Simple request, only mandatory fields.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?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>

The response body fields will be:

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. 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 be formed using:

When using a Multi Currency Terminal, the string to generate the HASH field is going to formed using:

ND002 - Additional Information on Response

This data is going to be sent back only when the Terminal executing the transaction is configured to do so. This configuration can be activated on the Terminal settings by enabling the “Integration” option “Enable original response in XML”. Currently two possible fields can be returned: ACQUIRER_RESPONSE_CODE and ACQUIRER_RESPONSE_TEXT, containing the original code and text from the acquirer's response to the authorization transaction.

ND003 - Secure Card Auto Registration

This field is returned when a secure card is created based on the card data passed in the request. This is only going to happen when the settings on Merchant Portfolio and Terminal align to allow the auto creation and storage of Secure Cards, and the request in place sends the details for a Secure Card (no TRACKDATA). If you are curious and want to know more about the settings, visit the | Important Integration Settings page.

ND004 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

• Scenario: Response to the initial simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<OFFLINEPAYMENTRESPONSE>
	<UNIQUEREF>JJCVGCTOV3</UNIQUEREF>
	<RESPONSECODE>A</RESPONSECODE>
	<RESPONSETEXT>APPROVAL</RESPONSETEXT>
	<MASKEDCARDNUMBER>4111******111111</MASKEDCARDNUMBER>
	<APPROVALCODE>475318</APPROVALCODE>
	<DATETIME>2005-11-14T12:53:18</DATETIME>
	<CVVRESPONSE>M</CVVRESPONSE>
	<HASH>3a540c54da7a6697cc61d3111a7024b8b8ae9a3d862b859c41a252b188d5d73ecfebc429ca809f60130c5e37b47b0d4494ebfb5f34c244f78c62a7d7a5896dd2</HASH>
</OFFLINEPAYMENTRESPONSE> 

This feature allows you to perform pre-authorization.

• Main Request body Tag: <PREAUTH>
• Main Response body Tag: <PREAUTHRESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. 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 be formed using:

When using a Multi Currency Terminal, the string to generate the HASH field is going to formed using:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Using Fraud Solution

If a merchant wishes to use Fraud Solution on its website, it must insert the Fraud Solution scripts to its website. These scripts create a profile on Fraud Solution servers and are used to validate the user's device..

<!-- Fraud Solution Profiling Tags -->
<script type="text/javascript" src="https://h.online-metrix.net/fp/tags.js?org_id=THEIR_ORD_ID&session_id=THEIR_SESSION_ID&pageid=PAGEID"></script>
<noscript>
    <iframe style="width: 100px; height: 100px; border: 0; position: absolute; top: -5000px;" src="https://h.online-metrix.net/fp/tags.js?org_id=THEIR_ORG_ID&session_id=THEIR_SESSION_ID&pageid=PAGEID"></iframe>
</noscript>

The parameters THEIR_ORG_ID and THEIR_SESSION_ID must be supplied by the merchant.

ND004 - Using eDCC

All eDCC enabled XML requests must include the FOREIGNCURRENCYINFORMATION tag and its nested tags.

Those fields can be obtained by using the eDCC Exchange Rate feature.

ND005 - Level II Data Validation

This field is associated with the feature “Level II Data”, and to be used it is necessary to set the “Allow Level II Data” option on a/the Processing Terminal “Features” section.

To provide a transaction with LEVEL 2, your request needs to add the LEVEL_2_DATA component and its fields, as described below.

Quick Example:

<LEVEL_2_DATA>
      <CUSTOMER_REF_NUMBER>SDGK-JSAAS-O235.00002314</CUSTOMER_REF_NUMBER>
      <TAX_AMOUNT>151.27</TAX_AMOUNT>
      <SHIPPING_ADDRESS>
                <FULL_NAME>JOHN SMITH AND ASSOCIATEDS</FULLNAME>
                <ADDRESS1>Unit 001, Street X</ADDRESS1>
                <ADDRESS2>Block "A", Neighborhood "A"</ADDRESS2>
                <CITY>City "Y"</CITY>
                <REGION>Region 1<REGION>
                <POSTCODE>A00B0001</POSTCODE>
                <COUNTRY>Country "Z"</COUNTRY>
      </SHIPPING_ADDRESS>
</LEVEL_2_DATA>          

ND006 - Level 3 Data Validation

This field is associated with the Transaction Enhanced Data feauture, and to be used it is necessary to have the “Allow Enhanced Data (Level II and Level III)” 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.

Quick example:

<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>
               <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>
               <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>         

ND007 - Multi Language Support

In case you desire to inform your customer's email and desire to provide his/her receipt in another language, you can use the Accept-Language parameter of the request to set language the customer should receive the receipt in. If the language informed is not supported, the Payment Gateway will use its default language (EN). Possible values are 'fr-FR' or even 'fr,en-US;q=0.9,en;q=0.8,ru;q=0.7,de;q=0.6,ru-RU;q=0.5,de-DE;q=0.4'

• Scenario: Simple request, only mandatory fields.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<PREAUTH>
	<ORDERID>100028374319</ORDERID>
	<TERMINALID>6491999</TERMINALID>
	<AMOUNT>15.62</AMOUNT>
	<DATETIME>18-12-2008:09:24:16:105</DATETIME>
	<CARDNUMBER>4111111111111111</CARDNUMBER>
	<CARDTYPE>VISA</CARDTYPE>
	<CARDEXPIRY>1109</CARDEXPIRY>
	<CARDHOLDERNAME>Joe Bloggs</CARDHOLDERNAME>
	<HASH>9c58e8d7ff9eb98db4ece2af75dec6ae</HASH>
	<CURRENCY>EUR</CURRENCY>
	<TERMINALTYPE>1</TERMINALTYPE>
	<TRANSACTIONTYPE>7</TRANSACTIONTYPE>
	<CVV>214</CVV>
</PREAUTH>

• Scenario: Pre-auth using eDCC, only mandatory fields.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<PREAUTH>
	<ORDERID>100028374319</ORDERID>
	<TERMINALID>6491002</TERMINALID>
	<AMOUNT>15.62</AMOUNT>
	<DATETIME>18-12-2008:09:24:16:105</DATETIME>
        <CARDNUMBER>4111111111111111</CARDNUMBER>
	<CARDTYPE>VISA</CARDTYPE>
	<CARDEXPIRY>1109</CARDEXPIRY>
	<CARDHOLDERNAME>Joe Bloggs</CARDHOLDERNAME>
	<HASH>9c58e8d7ff9eb98db4ece2af75dec6ae</HASH>
	<CURRENCY>EUR</CURRENCY>
	<FOREIGNCURRENCYINFORMATION>
		<CARDCURRENCY>GBP</CARDCURRENCY>
		<CARDAMOUNT>10.42</CARDAMOUNT>
		<CONVERSIONRATE>0.667157</CONVERSIONRATE>
	</FOREIGNCURRENCYINFORMATION>
	<TERMINALTYPE>1</TERMINALTYPE>
	<TRANSACTIONTYPE>7</TRANSACTIONTYPE>
	<CVV>214</CVV>
</PREAUTH> 

The response body fields will be:

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. 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 be formed using:

When using a Multi Currency Terminal, the string to generate the HASH field is going to formed using:

ND002 - Fraud Solution Response

In case the request of a transaction required the Fraud Solution verification, and the Terminal allowed, the result is then sent back at the FRAUDREVIEWRESPONSE field with the following subelements:

The response component FRAUDREVIEWRESPONSE would look like this inside the response body:

<FRAUDREVIEWRESPONSE>
    <FRAUDREVIEWSTATUS>PASS</FRAUDREVIEWSTATUS>
    <FRAUDREVIEWRISKRATING>LOW</FRAUDREVIEWRISKRATING>
    <FRAUDREVIEWSCORE>-10</FRAUDREVIEWSCORE>
    <FRAUDREVIEWREASONCODE>Profiling Blocked,Profiling Incomplete</FRAUDREVIEWREASONCODE>
</FRAUDREVIEWRESPONSE>

If a transaction is returned with “FRAUDREVIEWSTATUS” or “REVIEW”, this transaction can be changed to “APPROVE” or “REJECT”. For that, you have two options: let your users do that on the SelfCare System, using the new report feature or,through integration, they can use the Transaction Status Update feature, present on this page. Attention to those transactions which stay as “REVIEW”: they are not going to be settled until the transaction status is changed to “APPROVE” or “REJECT”. So, take a look at the Transaction Status Updatee or remind your users to review the transactions constantly/regularly.

ND003 - Additional Information on Response

This data is going to be sent back only when the Terminal executing the transaction is configured to do so. This configuration can be activated on the Terminal settings by enabling the “Integration” option “Enable original response in XML”. Currently two possible fields can be returned: ACQUIRER_RESPONSE_CODE and ACQUIRER_RESPONSE_TEXT, containing the original code and text from the acquirer's response to the authorization transaction.

ND004 - Secure Card Auto Registration

This field is returned when a secure card is created based on the card data passed in the request. This is only going to happen when the settings on Merchant Portfolio and Terminal align to allow the auto creation and storage of Secure Cards, and the request in place sends the details for a Secure Card (no TRACKDATA). If you are curious and want to know more about the settings, visit the | Important Integration Settings page.

ND005 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

• Scenario: Response to the initial simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<PREAUTHRESPONSE>
	<UNIQUEREF>JJCVGCTOV3</UNIQUEREF>
	<APPROVALCODE>475318</APPROVALCODE>
	<RESPONSECODE>A</RESPONSECODE>
	<RESPONSETEXT>APPROVAL</RESPONSETEXT>
	<PROCESSINGTERMINAL>6491002</PROCESSINGTERMINAL>
	<DATETIME>2008-12-18T09:24:17</DATETIME>
	<HASH>afe4c8b57f3ea0dfee7c8f75fae7e90d</HASH>
</PREAUTHRESPONSE>  

This feature allows you to perform a completion of a pre-authorization.

• Main Request body Tag: <PREAUTHCOMPLETION>
• Main Response body Tag: <PREAUTHCOMPLETIONRESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Using eDCC

All eDCC enabled XML requests must include the FOREIGNCURRENCYINFORMATION tag and its nested tags.

Those fields can be obtained by using the eDCC Exchange Rate feature.

• Scenario: Simple request to complete a pre-auth, only mandatory fields.
• Terminal: 6491002.
• Unique Ref of the original pre-authorization: JJCVGCTOV3.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<PREAUTHCOMPLETION>
	<UNIQUEREF>JJCVGCTOV3</UNIQUEREF>
	<TERMINALID>6491002</TERMINALID>
	<AMOUNT>12.31</AMOUNT>
	<DATETIME>19-12-2008:14:47:51:307</DATETIME>
	<CVV>785</CVV>
	<HASH>ff2e84856d7debbf07d3dfeffad5898c</HASH>
</PREAUTHCOMPLETION>

• Scenario: Pre-auth completion using eDCC, only mandatory fields.
• Terminal: 6491002.
• Unique Ref of the original pre-authorization: JJCVGCTOV3.
• Terminal Secret: x4n35c32RT.
• Important: The foreign currency information in the completion request is useful when completing an “out of 15% tolerance” transaction, because the original pre-auth transaction will be reversed and a new PAYMENT transaction will be authorized instead, and the foreign currency details provided will be used for the new transaction. The original pre-auth exchange rate is used when an eDCC transaction within the 15% tolerance is completed.

<?xml version="1.0" encoding="UTF-8"?>
<PREAUTHCOMPLETION>
	<UNIQUEREF>JJCVGCTOV3</UNIQUEREF>
	<TERMINALID>1001</TERMINALID>
	<AMOUNT>22.38</AMOUNT>
	<FOREIGNCURRENCYINFORMATION>
		<CARDCURRENCY>GBP</CARDCURRENCY>
		<CARDAMOUNT>14.93</CARDAMOUNT>
		<CONVERSIONRATE>0.667157</CONVERSIONRATE>
	</FOREIGNCURRENCYINFORMATION>
	<DATETIME>19-12-2008:14:47:51:307</DATETIME>
	<CVV>785</CVV>
	<HASH>ff2e84856d7debbf07d3dfeffad5898c</HASH>
</PREAUTHCOMPLETION>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. 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 be formed using:

When using a Multi Currency Terminal, the string to generate the HASH field is going to formed using:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

• Scenario: Response to the initial pre-auth completion request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

 <?xml version="1.0" encoding="UTF-8"?>
<PREAUTHCOMPLETIONRESPONSE>
    <UNIQUEREF>JJCVGCTOV3</UNIQUEREF>
    <RESPONSECODE>A</RESPONSECODE>
    <RESPONSETEXT>APPROVAL</RESPONSETEXT>
    <APPROVALCODE>515658</APPROVALCODE>
    <DATETIME>2008-12-18T14:47:51</DATETIME>
    <HASH>93527dbb00534a4b33546161aefe5222</HASH>
</PREAUTHCOMPLETIONRESPONSE>

Direct XML transactions (Payment, Pre-Auth and Pre-Auth Completion) can be DCC (Dynamic Currency Conversion) enabled. This is useful when card and terminal currencies are different. Our Payment Gateway supports Currency Conversion Rate requests. Merchant applications can request Conversion Rate for the card then the cardholder has to decide if he/she would like to use the eDCC service after which the appropriate request to the TPS will be sent. All eDCC enabled XML transaction requests should include the additional FOREIGNCURRENCYINFORMATION tag with all required nested tags.

This feature allows you to obtain eDCC exchange rates for specific terminals, depending on the Terminal's settings.

• Main Request body Tag: <GETCARDCURRENCYRATE>
• Main Response body Tag: <CARDCURRENCYRATERESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

• Scenario: Simple request.
• Terminal: 1001.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<GETCARDCURRENCYRATE>
	<TERMINALID>1001</TERMINALID>
	<CARDBIN>411111</CARDBIN>
	<DATETIME>27-06-2007:16:50:02:123</DATETIME>
	<HASH>15f6c0f0b51faff9cbb77220ab8ddfce</HASH>
</GETCARDCURRENCYRATE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

• [1] - CONVERSIONRATE: In this string CONVERSIONRATE must be a decimal value with 6 decimal places separated by dot character (‘.’), example: ‘0.123000’.

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

ND003 - Response Codes - Errors

• Scenario: Response to the simple request.
• Terminal: 1001.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<CARDCURRENCYRATERESPONSE>
	<TERMINALCURRENCY>EUR</TERMINALCURRENCY>
	<CARDCURRENCY>GBP</CARDCURRENCY>
	<CONVERSIONRATE>0.667157</CONVERSIONRATE>
	<EXCHANGERATESOURCENAME>Imaginary Bank</EXCHANGERATESOURCENAME>
	<MARGINPERCENTAGE>1.50</MARGINPERCENTAGE>
	<COMMISSIONPERCENTAGE>1.00</COMMISSIONPERCENTAGE>
	<FOREIGNAMOUNT>15.98</FOREIGNAMOUNT>
	<DATETIME>27-06-2007:16:50:02:999</DATETIME>
	<HASH>a12a10322f5af4a8a419f7dc1c6dd39f</HASH>
</CARDCURRENCYRATERESPONSE>

Some Acquiring Banks support Multi-currency Terminals. They allow Merchants processing transactions in one of a number of pre-defined currencies for a Terminal. This option allows Merchants to retrieve rates daily when using MCP Terminals, making possible to verify the accurate pricing of the currencies they desire to process transactions on.

This option is only available for TSYS Saratoga terminals, but if have any questions, Nuvei will inform you if your Terminal ID supports multi-currency. Contact our integration team if you have any questions relating to multi-currency terminals.

• Main Request body Tag: <GETFXCURRENCYRATE>
• Main Response body Tag: <FXCURRENCYRATERESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following format:

• Scenario: Simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<GETFXCURRENCYRATE>
	<TERMINALID>6491002</TERMINALID>
	<FXCURRENCY>EUR</FXCURRENCY>
	<BASEAMOUNT>12</BASEAMOUNT>
	<DATETIME>12-01-2018:11:47:04:656</DATETIME>
	<HASH>f7690c9ceaab0708415d370c8e28998cd29634985ef0cb036f969186a2c97a7934b8277c7153277180acfb61e78c1f37d70bf53d066362d9ebed8d1fca584575</HASH>
</GETFXCURRENCYRATE>

The response body fields will be:

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following format:

ND002 - Converting the Base Amount and Retrieving the

If the BASEAMOUNT is not informed on request, the FOREIGNAMOUNT is not generated, but the CONVERTIONRATE and the TERMINALCURRENCY are.

• Scenario: Response to the initial simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<FXCURRENCYRATERESPONSE>
	<TERMINALCURRENCY>USD</TERMINALCURRENCY>
	<FXCURRENCY>EUR</FXCURRENCY>
	<CONVERSIONRATE>0.889639</CONVERSIONRATE>
	<FOREIGNAMOUNT>10.68</FOREIGNAMOUNT>
	<DATETIME>20-09-2018:07:23:56:416</DATETIME>
	<HASH>ec14da3eddccf97279a32a3e90bff487facaa19c22fc88c6ebd48a2c1cd29473c3c05044732784c295fd8ae49db8f2281bf8d16accbdab880ae94b2232fa259e</HASH>
</FXCURRENCYRATERESPONSE>

Standard refunds can be performed on any authorized transactions in the Nuvei system, either in the Open Batch or Closed Batch. By default you can refund any amount up to 100% of the original transaction value. If multiple partial refunds are performed then the sum total of them cannot exceed 100% either. This is to prevent fraud. This 100% value is configurable at a Terminal level and if you wish to alter it please contact ecomsupport@merchant-support.com with a reason why you need it altered.

• Main Request body Tag: <REFUND>
• Main Response body Tag: <REFUNDRESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Multi Language Support

In Case you desire to inform your customer's email and desire to provide his/ her receipt in another language, you can use the Accept-Language parameter of the request to set language the customer should receive the receipt in. If the language informed is not supported, the Payment Gateway will use its default language (EN). Possible values are 'fr-FR' or even 'fr,en-US;q=0.9,en;q=0.8,ru;q=0.7,de;q=0.6,ru-RU;q=0.5,de-DE;q=0.4'.

• Scenario: Simple request, only mandatory data.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<REFUND>
	<UNIQUEREF>Q8F40S2V</UNIQUEREF>
	<TERMINALID>6491002</TERMINALID>
	<AMOUNT>10.00</AMOUNT>
	<DATETIME>20-06-2006:12:28:02:171</DATETIME>
	<HASH>cfa094f53a508d2031c7895f9f766cbb</HASH>
	<OPERATOR>Test Operator</OPERATOR>
	<REASON>Faulty Goods</REASON>
</REFUND>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

ND003 - Additional Information on Response

This data is going to be sent back only when the Terminal executing the transaction is configured to do so. This configuration can be activated on the Terminal settings by enabling the “Integration” option “Enable original response in XML”. Currently two possible fields can be returned: ACQUIRER_RESPONSE_CODE and ACQUIRER_RESPONSE_TEXT, containing the original code and text from the acquirer's response to the authorization transaction.

• Scenario: .
• Terminal: .
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<REFUNDRESPONSE>
	<UNIQUEREF>JJCVGCTOV3</UNIQUEREF>
	<RESPONSECODE>A</RESPONSECODE>
	<RESPONSETEXT>SUCCESS</RESPONSETEXT>
	<TERMINALID>6491002</TERMINALID>
	<AMOUNT>10.00</AMOUNT>
	<DATETIME>20-06-2006:12:28:03:875</DATETIME>
	<HASH>6a06aa6f14fe539f4dedd305465811ab</HASH>
</REFUNDRESPONSE>

Unreferenced refunds are refunds that do not require a payment transaction to be referenced. They are only available on certain accounts by request to ecomsupport@merchant-support.com and must also be approved by your Acquiring (merchant) bank. As an Unreferenced Refund does not refer to a payment transaction, it's necessary to inform the card on which the refund is going to. In this case, you have two possibilities: inform the card details (use the CARDDETAILS tag) or a valid Secure Card (use the CARDREFERENCE tag).

• Main Request body Tag: <UNREFERENCEDREFUND>
• Main Response body Tag: <UNREFERENCEDREFUNDRESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

When using a Secure Card (CARDREFERENCE) and a Single Currency Terminal, the string to generate the HASH field is going to formed using:

When using a Secure Card (CARDREFERENCE) and a Multi Currency Terminal, the string to generate the HASH field is going to formed using:

When NOT using a Secure Card and using a Single Currency Terminal, the string to generate the HASH field is going to formed using:

When NOT using a Secure Card and using a Multi Currency Terminal, the string to generate the HASH field is going to formed using:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Card Details

The CARDDETAILS tag has nested elements to represent the card information, as it follows:

ND004 - Multi Language Support

In Case you desire to inform your customer's email and desire to provide his/ her receipt in another language, you can use the Accept-Language parameter of the request to set language the customer should receive the receipt in. If the language informed is not supported, the Payment Gateway will use its default language (EN). Possible values are 'fr-FR' or even 'fr,en-US;q=0.9,en;q=0.8,ru;q=0.7,de;q=0.6,ru-RU;q=0.5,de-DE;q=0.4'.

• Scenario: Request to a specific card.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<UNREFERENCEDREFUND>
	<ORDERID>115073134</ORDERID>
	<TERMINALID>6491002</TERMINALID>
	<CARDDETAILS>
		<CARDTYPE>VISA</CARDTYPE>
		<CARDNUMBER>4111111111111111</CARDNUMBER>
		<CARDEXPIRY>0807</CARDEXPIRY>
		<CARDHOLDERNAME>Joe Bloggs</CARDHOLDERNAME>
	</CARDDETAILS>
	<AMOUNT>10.00</AMOUNT>
	<EMAIL>cardholder_email@worldnettps.com</EMAIL>
	<DATETIME>20-06-2006:12:28:02:171</DATETIME>
	<HASH>cfa094f53a508d2031c7895f9f766cbb</HASH>
	<OPERATOR>Test Operator</OPERATOR>
</UNREFERENCEDREFUND>

• Scenario: Request to a valid Secure Card.
• Terminal: 6491002.
• Secure Card: 2967534771694736 (CARDREFERENCE).
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<UNREFERENCEDREFUND>
	<ORDERID>115073134</ORDERID>
	<TERMINALID>6491002</TERMINALID>
	<CARDREFERENCE>2967534771694736</CARDREFERENCE>
	<AMOUNT>10.00</AMOUNT>
	<EMAIL>cardholder_email@worldnettps.com</EMAIL>
	<DATETIME>20-06-2006:12:28:02:171</DATETIME>
	<HASH>cfa094f53a508d2031c7895f9f766cbb</HASH>
	<OPERATOR>Test Operator</OPERATOR>
</UNREFERENCEDREFUND>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

ND003 - Additional Information on Response

This data is going to be sent back only when the Terminal executing the transaction is configured to do so. This configuration can be activated on the Terminal settings by enabling the “Integration” option “Enable original response in XML”. Currently two possible fields can be returned: ACQUIRER_RESPONSE_CODE and ACQUIRER_RESPONSE_TEXT, containing the original code and text from the acquirer's response to the authorization transaction.

• Scenario: Response to a simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<UNREFERENCEDREFUNDRESPONSE>
	<RESPONSECODE>A</RESPONSECODE>
	<RESPONSETEXT>SUCCESS</RESPONSETEXT>
	<UNIQUEREF>G53D0M1S4</UNIQUEREF>
	<TERMINALID>6491002</TERMINALID>
	<AMOUNT>10.00</AMOUNT>
	<DATETIME>20-06-2006:12:28:03:875</DATETIME>
	<HASH>6a06aa6f14fe539f4dedd305465811ab</HASH>
</UNREFERENCEDREFUNDRESPONSE>

Transaction updates allow you to update the status of a transaction in the Open Batch. You need to know the existing status of the transactions in order to update it.

• Main Request body Tag: <TRANSACTIONUPDATE>
• Main Response body Tag: <TRANSACTION UPDATERRESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Status Changing Constraints

Transactions' statuses can be updated as long as the change respect the following constraints:

• Scenario: Simple request, minimum data.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<TRANSACTIONUPDATE>
	<UNIQUEREF>Q8F40S2V</UNIQUEREF>
	<TERMINALID>6491002</TERMINALID>
	<OPERATOR>Test Operator</OPERATOR>
	<FROMSTATUS>PENDING</FROMSTATUS>
	<TOSTATUS>READY</TOSTATUS>
	<DATETIME>20-06-2006:12:28:02:171</DATETIME>
	<HASH>cfa094f53a508d2031c7895f9f766cbb</HASH>
</TRANSACTIONUPDATE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

• Scenario: Response to a simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<TRANSACTIONUPDATERESPONSE>
	<RESPONSECODE>A</RESPONSECODE>
	<RESPONSETEXT>SUCCESS</RESPONSETEXT>
	<UNIQUEREF>JJCVGCTOV3</UNIQUEREF>
	<TERMINALID>6491002</TERMINALID>
	<DATETIME>20-06-2006:12:28:03:875</DATETIME>
	<HASH>6a06aa6f14fe539f4dedd305465811ab</HASH>
</TRANSACTIONUPDATERESPONSE>

This update feature allows you to add enhanced data to transactions already processed, before they are settled. you need to know the existing transaction before sending your request.

• Main Request Body Tag: <UPDATE_TRANSACTION_ENHANCED_DATA>
• Main Response Body Tag: <UPDATE_TRANSACTION_DATA_RESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

[1] For each LINEITEM added, it's necessary to add all of its details, then add the details of the next item until the last one.

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

ND003 - Level 2 Data Validation

This field is associated with the Transaction Enhanced Data feature, and to be used it is necessary to have the “Allow Enhanced Data (Level II and Level III)” enabled with the “Transaction Data Level” option set as “Level II” on the Processing Terminal “Features” section.

To provide a transaction with LEVEL 2, your request needs to add the LEVEL_2_DATA component and its fields as described below.

ND004 - Level 3 Data Validation

This field is associated with the Transaction Enhanced Data feautre, and to be used it is necessary to have the “Allow Enhanced Data (Level II and Level III)” 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 (descriped before) and the LEVEL_3_DATA components and their fields. The LEVEL_3_DATA component fields are described below.

Information box

• Scenario: Simple request, minimum data
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT

<?xml version="1.0" encoding="UTF-8"?>
<UPDATE_TRANSACTION_ENHANCED_DATA>
    <TERMINALID>6491002</TERMINALID>
    <UNIQUEREF>DSF96457</UNIQUEREF>
    <OPERATOR>John Smith</OPERATOR>
    <LEVEL_2_DATA>
        <CUSTOMER_REF_NUMBER>SDGK-JSAAS-0235.00002314</CUSTOMER_REF_NUMBER>
	<TAX_AMOUNT>151.27</TAX_AMOUNT>
	<SHIPPING_ADDRESS>
	    <FULL_NAME>JOHN SMITH AND ASSOCIATES</FULL_NAME>
	    <ADDRESS1>Unit 001, Street X</ADDRESS1>
	    <ADDRESS2>Block "A", Neighborhood "A"</ADDRESS2>
	    <CITY>City "Y"</CITY>
	    <REGION>Region 1</REGION>
	    <POSTCODE>A00B0001</POSTCODE>
	    <COUNTRY>Country "Z"</COUNTRY>
	</SHIPPING_ADDRESS>
    </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>
    <DATETIME>12-06-2006:11:47:04:656</DATETIME>
    <HASH>3a540c54da7a6697cc61d3111a7024b8b8ae9a3d862b859c41a252b188d5d73ecfebc429ca809f60130c5e37b47b0d4494ebfb5f34c244f78c62a7d7a5896dd2</HASH>
</UPDATE_TRANSACTION_ENHANCED_DATA>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

[1] For each LINEITEM added, it's necessary to add all of its details, then add the details of the next item until the last one.

ND002 - Error Handling

If there is an error processing the transaction, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

• Scenario: Response to a simple request.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<TRANSACTIONUPDATERESPONSE>
    <TERMINALID>6491002</TERMINALID>
    <UNIQUEREF>DSF96457</UNIQUEREF>
        <LEVEL_2_DATA>
        <CUSTOMER_REF_NUMBER>SDGK-JSAAS-0235.00002314</CUSTOMER_REF_NUMBER>
	<TAX_AMOUNT>151.27</TAX_AMOUNT>
	<SHIPPING_ADDRESS>
	    <FULL_NAME>JOHN SMITH AND ASSOCIATES</FULL_NAME>
	    <ADDRESS1>Unit 001, Street X</ADDRESS1>
	    <ADDRESS2>Block "A", Neighborhood "A"</ADDRESS2>
	    <CITY>City "Y"</CITY>
	    <REGION>Region 1</REGION>
	    <POSTCODE>A00B0001</POSTCODE>
	    <COUNTRY>Country "Z"</COUNTRY>
	</SHIPPING_ADDRESS>
    </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>
    <DATETIME>12-06-2006:11:47:04:656</DATETIME>
    <HASH>3a540c54da7a6697cc61d3111a7024b8b8ae9a3d862b859c41a252b188d5d73ecfebc429ca809f60130c5e37b47b0d4494ebfb5f34c244f78c62a7d7a5896dd2</HASH>
</TRANSACTIONUPDATERESPONSE>

This feature allows you to retrieve a transaction already processed. You need to know the existing transaction before sending your request.

• Main Request body Tag: <GET_TRANSACTION_DETAILS>
• Main Response body Tag: <GET_TRANSACTION_DETAILS_RESPONSE>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Data Encoding for Requests

All data sent to us should be correctly encoded using UTF-8 as the character encoding.

• Scenario: Simple request, minimum data.
• Terminal: 6491002.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<GET_TRANSACTION_DETAILS>
    <TERMINALID>6491002</TERMINALID>
    <UNIQUEREF>GCNQAWUUVZ</UNIQUEREF>
    <DATETIME>06-03-2018:17:41:08:273</DATETIME>
    <HASH>73e340cfb2b7424252d1ced917e4f74704aaa66a9600039f4800434cefe87d721c342d2b915c6e2aeea88b34e749ba97665f7d9e50b1144ca0f0745361fc4896</HASH>
</GET_TRANSACTION_DETAILS>

ND001 - Hash Formation

The general rule to build the HASH field is given on the Special Fields and Parameters page, under the Special Fields and Parameters section. For this specific feature, you should use the following formats:

ND002 - Error Handling

If there is an error processing the request, the error string is returned in an XML message with the simple tags:

<ERROR>
    <ERRORSTRING>This is the error generated!</ERRORSTRING>
</ERROR>

• Scenario: Response to a simple request.
• Terminal: 3614008.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GET_TRANSACTION_DETAILS_RESPONSE>
    <TERMINALID>3614008</TERMINALID>
    <UNIQUEREF>E4RGZYVCME</UNIQUEREF>
    <TRANSACTION_STATUS>REVIEW</TRANSACTION_STATUS>
    <TRANSACTION_DATE>26-04-2019:17:19:18:000</TRANSACTION_DATE>
    <OPERATOR>CardHolder Payment</OPERATOR>
    <TRANSACTION_TYPE>SALE</TRANSACTION_TYPE>
    <CURRENCY>USD</CURRENCY>
    <AUTHORIZEDAMOUNT>52.03</AUTHORIZEDAMOUNT>
    <ADDITIONAL_DETAILS>
        <RESPONSECODE>A</RESPONSECODE>
        <RESPONSETEXT>APPROVAL</RESPONSETEXT>
        <APPROVALCODE>VVVVWM</APPROVALCODE>
        <TRANSACTION_CUSTOM_FIELDS>
            <TRANSACTION_CUSTOM_FIELD>
                <NAME>Promocode</NAME>
                <VALUE>sevr9w409vw4v59w45v</VALUE>
            </TRANSACTION_CUSTOM_FIELD>
        </TRANSACTION_CUSTOM_FIELDS>
    </ADDITIONAL_DETAILS>
    <DATETIME>30-04-2019:14:34:47:707</DATETIME>
    <HASH>61a587361fa4631a72af9d47395ad0ab81cb6b5928ed8b41ab0860e7cd52c4bc55361f3d3c0b8cf52add999c0c5c07acd6f8f26c0b045d33c0d97489b3f6be9a</HASH>
</GET_TRANSACTION_DETAILS_RESPONSE>