XML Terminal Features

This feature enables your integration to retrieve a terminal's configuration. This was introduced to facilitate the configuration of your integrations, enabling your solution to verify settings before sending requests and to avoid wrong requests and inconsistencies while integrating with the Payment Gateway.

The following resources are the same for all the requests and responses you find in 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.

During the boarding process of a Merchant, one or a set of terminals is configured to process transactions. Many important settings, which could change over time to adapt to the Merchant's needs, are kept in these terminals' configuration section.

Using this solution, you can consult a terminal's configuration in order to apply specific conditions and rules dynamically, without having to manually manage the changes in the terminal's configurations.

• Main Request body Tag: <TERMINAL_CONFIGURATION>
• Main Response body Tag: <TERMINAL_CONFIGURATION_RESPONSE>

ND001 - Hash Formation

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

For this specific feature, you should consider the following format:

• Scenario: Request of terminal settings without custom fields language definition (gets default).
• Merchant/Terminal: 3614/3614006.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF8"?>
<TERMINAL_CONFIGURATION>
    <TERMINALID>3614006</TERMINALID>
    <DATETIME>06-03-2018:17:41:08:273</DATETIME>
    <HASH>44ada4060336a13b8d8a145c3f65865c</HASH>
</TERMINAL_CONFIGURATION>

The response body will contain many of the main terminal settings. The Payment Gateway is going to send back the response and you need to prepare your integration to extract those settings. The response body fields will be:

ND001 - Hash Formation

The general rule to build HASH field is given at the Special Fields and Parameters page, under the Special Fields and Parameters section.

For this specific feature, you should consider the following format:

• [1] - SUPPORTED_CURRENCIES: concatenation of all the <CURRENCY> elements returned within this field.
• [2] - SECURE_CARD_STORAGE: concatenation of all the subelements of this element ( ENABLED:ALLOW_SUBSCRIPTION ).
• [3] - ENHANCED_DATA: concatenation of all the subelements of this element ( ENABLED:TXN_DATA_LEVEL:API_ADDRESS_MODE ).
• [4] - AVS: concatenation of all the subelements of this element ( ENABLED:COMPULSORY:API_ADDRESS_MODE ).
• [5] - SENTINEL_DEFEND: concatenation of all the subelements of this element ( ENABLED:ORGANIZATION_ID:FRAUDREVIEWSESSIONID ).
• [6] - CUSTOM_FIELDS: concatenation of all the <CUSTOM_FIELD> elements returned withing this field. Each CUSTOM_FIELD returned is going to be formed by the concatenation of all of its subelements: NAME:DISPLAY_NAME:DISPLAY_ORDER:TYPE:PAYMENT_PAGE:MANDATORY.

ND002 - Response Codes - Errors

• Scenario: Response of the first request example.
• Merchant/Terminal: 3614/3614006.
• Terminal Secret: x4n35c32RT.

<?xml version="1.0" encoding="UTF-8"?>
<TERMINAL_CONFIGURATION_RESPONSE>
    <TERMINALID>3614006</TERMINALID>
    <BANK_SETTINGS>
        <CURRENCY>EUR</CURRENCY>
        <ALLOW_MULTICURRENCY>false</ALLOW_MULTICURRENCY>
        <ALLOW_EMCP>false</ALLOW_EMCP>
        <ALLOW_EDCC>true</ALLOW_EDCC>
        <ALLOW_MOTO>true</ALLOW_MOTO>
        <ALLOW_CHP>false</ALLOW_CHP>
        <ALLOW_INTERNET>true</ALLOW_INTERNET>
    </BANK_SETTINGS>
    <SUPPORTED_CURRENCIES>
        <CURRENCY>EUR</CURRENCY>
    </SUPPORTED_CURRENCIES>
    <FEATURES>
        <SECURE_CARD_STORAGE>
            <ENABLED>true</ENABLED>
            <ALLOW_SUBSCRIPTION>true</ALLOW_SUBSCRIPTION>
        </SECURE_CARD_STORAGE>
        <ENHANCED_DATA>
            <ENABLED>false</ENABLED>
            <TXN_DATA_LEVEL>LEVEL_II</TXN_DATA_LEVEL>
            <API_ADDRESS_MODE>POSTAL</API_ADDRESS_MODE>
        </ENHANCED_DATA>
    </FEATURES>
    <SECURITY_FRAUD>
        <SHOW_CVV>true</SHOW_CVV>
        <AVS>
            <ENABLED>false</ENABLED>
            <COMPULSORY>false</COMPULSORY>
        </AVS>
        <ALLOW_MAX_MIND>false</ALLOW_MAX_MIND>
        <SENTINEL_DEFEND>
            <ENABLED>false</ENABLED>
        </SENTINEL_DEFEND>
    </SECURITY_FRAUD>
    <INTEGRATION>
        <ENABLE_BACKGROUND_VALIDATION>true</ENABLE_BACKGROUND_VALIDATION>
    </INTEGRATION>
    <ALLOW_ACH_JH>false</ALLOW_ACH_JH>
    <CUSTOM_FIELDS>
        <CUSTOM_FIELD>
            <NAME>PRODUCT_SKU</NAME>
            <DISPLAY_NAME>Product SKU</DISPLAY_NAME>
            <DISPLAY_ORDER>1</DISPLAY_ORDER>
            <TYPE>STRING</TYPE>
            <PAYMENT_PAGE>true</PAYMENT_PAGE>
            <MANDATORY>false</MANDATORY>
        </CUSTOM_FIELD>
        <CUSTOM_FIELD>
            <NAME>AFFILIATE_ID</NAME>
            <DISPLAY_NAME>Affiliate ID</DISPLAY_NAME>
            <DISPLAY_ORDER>2</DISPLAY_ORDER>
            <TYPE>STRING</TYPE>
            <PAYMENT_PAGE>true</PAYMENT_PAGE>
            <MANDATORY>false</MANDATORY>
        </CUSTOM_FIELD>
    </CUSTOM_FIELDS>
    <DATETIME>29-03-2018:17:58:31:686</DATETIME>
    <HASH>44adsokrv986a13b8d8a145c92jsue12</HASH>
</TERMINAL_CONFIGURATION_RESPONSE>