Merchant Portal User Manual

## Sections
• [Introduction](https://developer.pay.tnsi.com/merchant-portal-user-manual/introduction.md): Welcome to the TNS Merchant Portal User Guide for the TNS Payment Orchestration Platform. This guide is designed to help merchants effectively navigate and utilize the features and functionality available in the merchant portal. The merchant portal is a comprehensive tool for customers to manage their merchants, merchant accounts, transactions, and access reports all within the TNS Payment Orchestration Platform. This guide will walk you through the various features and provide step-by-step instructions to help you make the most of the merchant portal. Invitation Email and Account Activation When a new user is created, they receive an invitation email containing instructions to activate their account. The account activation process includes setting up a password and completing the initial login steps, including Multi-Factor Authentication (MFA). To activate the account, perform the following steps: 1. Invitation Email Check your inbox for an email from noreply@tnso.tnsi.com with the subject line "Verify Your Email Address." Open the email and click the Verify Email button to verify the email. 2. Login and Reset Password Click on the link to the Merchant Portal you have been granted access too. Login with your email address and temporary password The Change Password screen will be displayed. Change your password, ensure if follows the minimum password requirements as displayed on the screen. Click the Change password to save your password. 3. Additional Authorization - Multi-Factor Authentication (MFA) After setting up your password, proceed to complete the Multi-Factor Authentication (MFA) process. Multi-Factor Authenication (MFA) is a security method that the user to provide a different set of credentials to verify their identity. With the TNS Payment Orchestration Portal, MFA is accommodated by the supply of a 6 digit Verification Node . There are three options for MFA verficiation: Email SMS Authenticator App Select your preferred option and click Next . Pl ease Note : If you select email as the authentication preference, a Mobile Number will still be required with a 2FA to validate you are a genuine user. 4. Setting up MFA Title Description MFA Setup for Email If you have selected Email as your MFA method you will need to follow these steps. Click Verify to continue. An email willbe sent to your Email address with the 6-digit Verification Code. N ote : For Email MFA, you will also need to complete SMS MFA to verify your account. Email will still be used for MFA going forward. MFA Setup for SMS If you have selected SMS as your MFA method you will need to follow these steps.Note: This same process is used to support MFA for Email Address. Select your Country Code and enter your the phone number in the Phone Number field. Tick the box to accept the Terms and Privacy Policy You cannot proceed without accepting the Terms and Privacy Policy. Click Verify . A 6-digit code is sent to the entered phone number. MFA Setup for Authenticator Apps If this option is selexted you will be displayed a screen to configure you're chosen authenticator app. 5. Verfiying Email and SMS MFA Depending on whether you have selected Email or SMS you will receive a message from TNS supplying you with a 6 digit Verification Code to enter. The email will be titled: Verify Your Email Address from noreply@tnspaysso.tnsi.com . Example of an email MFA verify screen a similar screen appears for SMS verification. The SMS Screen has an additional button to Resend Code if it has the code has not been received. Enter the code and click V erify (for Email) or Confirm (for SMS). Once this is complete, your MFA preferences are set and you will be taken to the Merchant Portal login screen. Changing your MFA preference You can change your MFA preference at any time. See here for details. Accessing the Merchant Portal To access the Merchant Portal, perform the following steps: Open your web browser and navigate to the TNS Merchant Portal login page that you have been provided access to. The Merchant Portal Login page displays. Enter your credentials: Enter your email in the Email field Enter your password in the Password field. Click the Login button. Multi-Factor Authentication (MFA): Upon clicking the Login button, a 6-digit MFA code is generated and sent to your registered email address or mobile number (you can opt for SMS or email for MFA). Check your email or SMS for the MFA code. Enter the 6-digit code in the verification code field on the Merchant Portal login page. Click Sign In to log into the Merchant Portal. After verification, you are redirected to the Merchant Portal dashboard. Issue: Unable to Login to Merchant Portal as MFA Code is Not Sent to Email ✅ Happy Path (Expected Flow) Login to the Merchant Portal. Create a new user within the system. Logout from the Merchant Portal. The newly created user receives an email with an activation link. The user clicks on the link to set a password. The user logs into the Merchant Portal with the new credentials. The user receives an access code via email for Multi-Factor Authentication (MFA). The user enters the access code and successfully logs into the application. ❌ Failure Path (Issue Scenario) Login to the Merchant Portal. Create a new user within the system. The newly created user receives an email with an activation link. The user clicks on the link to set a password. The user logs into the Merchant Portal with the new credentials. ❗ Issue: The MFA access code is not received via email. Result: The user is unable to log in to the application. Troubleshooting Steps (If MFA Code is Not Received) Close All Open Browser Tabs and Try Again : Sometimes, multiple active sessions may cause issues. Close all browser tabs and reopen the activation link from the email. Check Spam/Junk Folder : The email might have been filtered. Resend MFA Code : If the portal provides an option to resend the code, try again. Verify Email Configuration : Ensure the email address used for the new user is correct. Contact Support : If the issue persists, escalate to the IT support team. Forgotten Password If you have forgotten or need to reset your password, you can use the Forgot Password link from the Merchant Portal login page. Click the Forgot Password link. 2. Enter the Email for the account you want to reset your password for. 3. Click Reset My Password . 4. MFA is requested to authenicated you as a user. You will have received an email with a 6-digit verification code. Enter the code supplied and click Sign In to be taken into the Merchant Portal.
  • [User Interface Overview](https://developer.pay.tnsi.com/merchant-portal-user-manual/introduction/user-interface-overview.md): When you log into the Merchant Portal, you are greeted with a comprehensive dashboard that provides an overview of your transaction data and other key metrics. This interface is divided into several main sections, each designed to help you navigate and manage your account effectively. Top Menu Bar The top menu bar appears from the top right corner of the screen. It provides quick access to essential features and settings: AI Assistant : The AI Assistant is an intelligent, conversational interface designed to provide instant support and data insights. Global Search : Located at the center of the top menu bar, the search bar allows you to quickly find transactions using criteria such as Reference Number, Auth Code, Receipt Number, and RRN for the last 90 days. Contact Support : Provides a form to submit general inquiries or issues, specifying the merchant, preferred reply method (email or phone), and detailing your question and message. Notifications : Check for Merchant Portal notifications that have been sent to you. User Icon Menu : On the right side, you will find an icon that expands to show options like changing your password, Auth Preference, and logging out. Main Menu Bar The main menu bar on the left side of the screen offers easy navigation to various sections of the admin portal, Dashboard :The screen you land on when logging in. It displays statistical information about business. Account Management : Manage users, configure settings, and oversee API keys for your customer, level, and merchant accounts Terminal Management: Access terminal details associated with merchants and search feature. Transactions : Access and manage transaction data. Reports : Generate detailed reports on various aspects of your transactions. Token Service : Manage tokens for secure transactions. Recurring Payments : Manage recurring payments. Maintenance : Access maintenance-related tools and settings.
• [Top Menu Bar Functions](https://developer.pay.tnsi.com/merchant-portal-user-manual/top-menu-bar-functions.md): The top menu bar in the Merchant Portal provides quick access to essential features and settings that enhance the user experience and ensure efficient account management. AI Assistant : A powerful, real-time support tool integrated directly into the Merchant Portal. It is designed to help you navigate the platform, analyze complex transaction data, and provide instant answers to configuration or reporting questions using natural language. Global Search : This feature allows you to quickly find specific transactions based on various criteria, providing a convenient way to access transaction data from the last 90 days. Contact Support : This feature provides a straightforward way to get help or ask questions about the portal, ensuring you have access to the assistance you need for any issues or inquiries. Notifications : This feature allows the user to check and act on notifications they have received. User Icon Menu Change Password : Allows the user to change their password. Change Authentication Preferences : Allows the user to change their Authentication (MFA) preference between email and SMS. Change Preferences : Allows the user to change their default language and time zone. Log out The subsections describe how each option can be used.
  • [AI Assistant](https://developer.pay.tnsi.com/merchant-portal-user-manual/top-menu-bar-functions/ai-assistant.md): The AI Assistant is an intelligent, conversational interface designed to provide instant support and data insights. It allows you to interact with the Merchant Portal using natural language to retrieve transaction details, manage merchants, and analyze business performance. Features and Capabilities The AI Assistant provides shortcut categories to help you get started quickly: Transactions: Request specific transaction data, such as "Show last 5 transactions" or "Show transaction for Auth Code XXXX." Merchants: Manage your portfolio by asking to "Search Merchant X" or "List active merchants." Volume & Performance: Get high-level business intelligence, such as "Show last week volume and count" or "How is business performing this month?" How to Use the AI Assistant Open the Interface: Click the + AI Assistant button in the top menu bar. Select Context: Use the Customer dropdown at the top of the chat window to filter data for a specific account. Input Your Query There are three options available for entering your query: Type: Enter your question in the "Ask Me..." text box. Voice: Click the Microphone icon to use voice-to-text input. Using Examples: Examples appear in the middle of your screen, at the estart of an AI Assistant session and also on the Example sidebar on the righthand side. Clicking on an example populates the “Ask Me…” text box. Navigation & Data: Use the toggle at the bottom left of the input box to switch between Navigation & Data mode and Knowledge Base mode. Navigation & Data mode: Use this mode when you want the AI to do something or fetch real data (transactions, volumes, merchant lookups). Knowledge Base mode: Use this mode when you want the AI to explain something or answer a question about how the portal works. Review History: Access previous queries and responses in the Last Week sidebar on the right. AI Assistant History The AI Assistant History feature allows you to revisit and review previous conversations, ensuring you have constant access to past insights, data analysis, and guidance. Accessing Past Conversations On the right-hand sidebar of the AI Assistant interface, you will find the Last Week history log. This section displays a list of your recent queries. Reviewing a Chat: Click on any past message (e.g., "Show chart for last week volume...") to reload that specific conversation. Dynamic Data Recovery: When you click a historical item, the AI Assistant will reopen the chat window and display the original response, including any generated tables or charts (as seen in screenshot above). Visual Reports: If a previous query resulted in a bar or line chart, clicking that history item will re-render the visual data for quick comparison. Managing the History Sidebar New Conversation: To start a fresh session without distractions, click the + New Conversation button at the top of the sidebar. This does not delete your history but clears the current active workspace. Deleting History: To remove a specific entry from your log, click the Trash Can icon located on the right side of the individual history bubble. Collapsing the Sidebar: If you need more workspace for a complex chart, you can use the blue arrow tab to collapse or expand the history sidebar. Examples Sidebar The Examples sidebar is a built-in library of pre-configured prompts designed to help you get the most out of the AI Assistant. It serves as a quick-start guide, showing you exactly how to phrase questions to retrieve specific data or navigate the portal. Using the Examples Sidebar Accessing Examples: Click the Example dropdown at the bottom right of the AI interface to expand a list of frequently used queries. One-Click Search: Instead of typing, you can simply click on any example (e.g., "Show last month volume by card type" ) to instantly populate the search bar and execute the request.
  • [Global Search](https://developer.pay.tnsi.com/merchant-portal-user-manual/top-menu-bar-functions/global-search.md): The Global Search feature in the Merchant Portal allows you to quickly find specific transactions based on various criteria. This search bar is located in the Top Menu Bar and provides a convenient way to access transaction data from the last 90 days. Using the Global Search To use the Global Search feature, perform the following steps: Navigate to the search bar located in the Top Menu Bar of the Merchant Portal. 2. Enter the search criteria. You can search for transactions using the following criteria: Reference Number : The unique reference number associated with a transaction. Auth Code : The authorization code provided during the transaction process. Receipt Number : The receipt number generated for the transaction. RRN : The Retrieval Reference Number for the transaction. 3. After entering the desired search criteria, press Enter . The search results display relevant transactions matching your criteria. Example of Global Search Usage If you want to find a transaction using its receipt number, enter the receipt number in the search bar and press Enter . The search results show transactions from the last 90 days that match the entered receipt number.
  • [Contact Support](https://developer.pay.tnsi.com/merchant-portal-user-manual/top-menu-bar-functions/contact-support.md): The Contact Support feature in the Merchant Portal provides an easy way for users to get help or ask questions about the portal. When you need assistance, you can use this feature to reach out to the Support team. To contact the Support team, perform the following steps: In the top menu bar, click the Support icon. A window slides in from the right side of the screen. 2. Fill in the details: 3. Merchant : Select the merchant account related to your inquiry from the dropdown menu. If your question applies to all your merchants, select All . Reply To Me By : Choose your preferred method of contact. You can select either Email or Phone . Specify your question: Your Question : Select the type of question you have from the dropdown. The question will indicate if it will be directed to the Support or Sales teams. Message : Enter the details of your question or issue in the Message field. Be as detailed as possible to help the Support team assist you effectively. 4. After filling in all required fields, click the Send Message button to send your question. Example of Filling the Contact Support Form Merchant: Select All if your question is general, or choose a specific merchant if your inquiry is account-specific. Reply To Me By: Select Email if you prefer a response through email. Your Question: Choose "I have a question about the product (email Sales)" if your inquiry relates to the product. Message: Enter your detailed question or issue, such as "I need assistance with understanding the transaction report feature." Click Send Message to send the message. In this case it woul be sent to the Sales team. After the message is sent, a ticket number is generated, and the support team contacts you through your preferred mode of communication (email or phone). By following these steps, you can easily contact Support and get the help you need with the Merchant Portal.
  • [Notifications](https://developer.pay.tnsi.com/merchant-portal-user-manual/top-menu-bar-functions/notifications.md): Details coming soon.
  • [User Icon Menu](https://developer.pay.tnsi.com/merchant-portal-user-manual/top-menu-bar-functions/user-menu.md): The User Menu allows you to: My Account - which takes the user to a separate portal to manage Personal Details, Phone Number, Password and Two Factor Authenication (TFA) Change your preferences - for Language and Time Zone Logout Individual subsections describe how the “Change” options are used.
    • [My Account](https://developer.pay.tnsi.com/merchant-portal-user-manual/top-menu-bar-functions/user-menu/my-account.md): The My Account menu option provides the user with the ability to change their name, password, phone number and MFA. Ths page includes email address, but this cannot be changed by the user but via a request to a TNS Support team. Title Description Name Change A screen appears on the right-hand side allowing maintenance of the user's name. Phone Number Change A screen appears on the right-hand side allowing maintenance of the phone number. Password Change A screen appears on the right-hand side allowing maintenance of the password. Change Two Factor Authentication (TFA) A screen appears on the right-hand side allowing maintenance of the authentication method. After making your selection you be asked for further detail and to verify the method works. This is similar to what occurs when first sigining into the Merchant Portal.
    • [Change Authentication Preference](https://developer.pay.tnsi.com/merchant-portal-user-manual/top-menu-bar-functions/user-menu/manage-mfa.md): The Change Authentication Preference feature allows you to configure and manage your Multi-Factor Authentication preferences to enhance the security of your account. By default, your email is used to receive a 6-digit authentication code. However, you can change the MFA preference to SMS by adding your mobile phone number (if not added during the user registration process) and receive the 6-digit authentication code via SMS on the registered phone number To manage your MFA settings, perform the following steps On the Top Menu Bar, click on the User icon. 2. Select Change Authenticiation Preference from the dropdown menu. A window will slide in from the right side of the screen. 3. Select the authentication preference: Email : The security code is sent to the specified email. Phone : A security code is sent to the specified phone number. 4. If you select SMS and no phone number has been registered, you will need to add a phone number - click Add Phone Number . 5. Enter a phone number to be used for MFA in the Phone Number field. Your phone number must be entered with the country code and without spaces. 6. A 6-digit code is sent to the entered phone number. Enter the 6-digit code in the verification code field. If you haven't received the 6-digit code, click Resend Code to resend the 6-digit code for entry into the verification code field. If you continue to not receive a SMS, click Cancel and make sure your phone number has been entered correctly. 7. Click Submit . By following these steps, you can manage your MFA settings, adding an extra layer of security to your account.
    • [Change Preferences](https://developer.pay.tnsi.com/merchant-portal-user-manual/top-menu-bar-functions/user-menu/change-preference.md): The Change Preferences feature allows you to update your personal system settings such as language and time zone . These preferences help customize the portal interface and ensure that date and time information is displayed according to your selected region. To manage your preferences, perform the following steps: In the Top Menu Bar, click the User icon. From the dropdown menu, select Change Preferences . A window will slide in from the right side of the screen. 3. In the Change Preferences panel: Select your preferred Language from the dropdown list. Select your preferred Time Zone from the dropdown list. Note: they both need to have a value to be saved. 4. Click Save to apply the changes or Cancel to close the panel without saving. Once saved, the portal will update the settings based on your selected preferences.
• [Dashboard Overview](https://developer.pay.tnsi.com/merchant-portal-user-manual/dashboard-overview.md): The Dashboard provides a view of different metrics across a date range and selected merchants for the Customer. You can select the Reporting Type - Sales, Transaction Count - and apply different filters t on the Dashboard to target the area of information you may be after. Individual widgets present the metrics based on the filters entered for reporting. Reporting Type and Filters Reporting Type allows you to select how you want to summarise your metrics. There are two options: Sales - metrics are compiled by Sales amount. Transaction Count - metrics are compiled based on the Transaction Count. The data used to must meet the filters that are defined for the dashboard. Filters allow you to further define the parameters for the metrics to be reported on. Date Range: The date range over which the data will be summarised for the metrics. This default to a month ending today's date. The data range must be set for the widgets to be populated. Merchant: The merchants that are attached to the Customer. This defaults to the all the levels and merchants for the customer. At least one merchant must be selected for the widgets to be populated. Currency: This filter restricts reporting to the selected currency. Only transactions for that currency will be used to compile the metrics. A currency must be selected for the widgets to be populated. Acquirer: This filter can restrict the metrics to a specific acquirer. The default is to have no Acquirer selected, which means all acquirers are included. Entry Mode: This filter allows the uuser to select the card entry method for the transaction, for example: EMV Contactless, Magstripe or Keyed. By default, all entry modes are reported if no Entry Mode is selected. Card Scheme: This filter allows the user to elect the Card Scheme, for example: Visa, Mastercard, Diners, Amex etc, to report on. By default, this is left blank and all card schemes are reported on. Note: For the widgets to populate, at a minimum, the Date Range, Merchant and Currency must be selected. Widgets The widgets present the data based on the Reporting Type and filters selected. They provide insights based on total settled sales or transaction count within the specified date range. Adjusting the Reporting Type or any of the filters will cause all the widgets to update themselves. Widgets, that have the three dots menu in their top right hand corner can be displayed using different types of graphs. The options available are: Title Description The Default graph type is the one first displayed when the dashboard is viewed. The Default graph type differs across the widgets. The widget will retain the graph type, if it is changed, for the next time the user logs in. Total Settled Sales Total Settled Sales is presented by two widgets. The Total Settled Sales Summary (lefthand side) presents a summary of statistics based on teh reporting type and filters set. The Total Settled Sales graph (righthand side) shows settled sales by day over the date range. The graph also allows you to compare the filtered date range to 3 pre-defined periods: The previous month based on a week earlier. For example: if the filter date range is 21 June 2026 - 21 July 2026, this option would be 14 June 2026 - 14 July 2026. The previous month, based on the date. For example: if the filter date range is 18 April 2026 - 18 May 2026, this option would be 21 May 2026 - 21 June 2026. The same date range for the previous year - allowing a year on year type comparision. For example: if the filter date range is 21 June 2026 - 21 July 2026, this option would be 21 June 2025 - 21 July 2025. The comparative graph is presented in a different colour, green in this example, with the date range defined on the graph. Moving your cursor over the graph will present the dates the individual graphs represent at that point. Title Description Transaction Status This widget presents approved and declined transaction percentages over the data range. Transaction Type This widget presents of transaction by Transaction Type, for example: Sale, Refund or Void. POS Terminal vs E-commerce This widget compares transactions from POS terminals and e-commerce platforms. Card Schemes This widget displays the distribution of different card schemes (e.g., Visa, MasterCard, AMEX) used in transactions. POS Terminal Card Entry Mode This widget shows the card entry modes used at POS terminals, such as chip, swipe, or contactless. Ecommerce Channel This widget provides data specific to e-commerce channels, such as PayPal, Card, Apple Pay, and Google Pay.
• [Account Management](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management.md): The Account Management section offers comprehensive tools to manage users, configure settings, and oversee API keys for your customer, level, and merchant accounts. When you select Account Management from the main navigation menu, you will be directed to the account management screen where you can efficiently navigate and manage your account hierarchy using the hierarchy selector menu or search function. Within the hierarchy selector there are three types of nodes: Customer: This is the top level node that represents your company overall. Level: Levels allow you to group merchants together. For example, this may be geographically or by the type of business they conduct. Merchants at this level are positioned next to customers. They have the privilege to create sublevels, allowing merchants under them to create users within their respective levels. It is possible to have sub-levels of levels, if you want to further breakdown your account structure. Merchants : These are you merchants, through which transactions are captured. With this hierarchy setup, there are configurations and controls that can be defined at a higher level, that are inherited by merchants that sit under that node. Some of the merchant set up can depend on the level above it. This documentation will identify where inheritance is applied. Users can also be defined at each level. A user has access to the node they have been allocated to and the child nodes that sit underneath that as well. Hierarchy Selector The Hierarchy Selector menu allows you to select and view details for specific customers, levels, or merchants. This feature helps organize and manage the different hierarchical levels within your merchant account structure. You can easily search for and navigate to specific accounts, making account management more efficient and streamlined. Search Customer , Level, and Merchant : Use the search function to find specific items within the hierarchy. Details : Displays the selected customer, level, or merchant information. Users : View and manage user accounts associated with the selected customer, level, or merchant. API Keys : View and manage API keys associated with the selected customer, level, or merchant. Hierarchy Structure Customer: The top-level hierarchy that includes all users within the customer's organization. Level : A sub-level within the customer that may include multiple merchants. Merchant: The lowest level in the hierarchy, specific to individual merchants. Users and API keys at the Merchant level are also displayed at the Level and Customer levels. Similarly, users and API keys at the Level level are displayed at the Customer level. Details The Details tab in the Account Management section provides general information and settings for different hierarchy levels within your merchant account. Depending on whether you are viewing a Customer, Level, or Merchant, the information displayed varies. This section outlines the fields available for each hierarchy level. Customer For customers, the Details tab includes the following fields: Company Name : The name of the customer's company. (e.g., Petron) Country : The country where the customer is located. (e.g., Australia) HQ Address : The headquarters address of the customer. (e.g., 123 Main Street) City : The city where the headquarters is located. (e.g., Cityville) State : The state where the headquarters is located. (e.g., Western Australia) Zip Code : The postal code for the headquarters. (e.g., [Enter the zip code]) Level For a level, the Details tab includes the following fields: Level Name : The name of the level within the customer's hierarchy. (e.g., Level_Spectra) Billing ID : A unique identifier associated with the billing account for this level. (e.g., 12312) Party ID : A unique identifier for the party associated with this level. (e.g., 123123) Salesforce ID : The identifier used in Salesforce for this level. (e.g., SF1234564251) Country : The country associated with this level. Time Zone : The time zone in which this level operates. Activation Status : This indicates whether this level is currently active or inactive. (e.g., Active) Merchant For merchants, the Details tab includes the following fields: Billable ID : A unique identifier for billing purposes. (e.g., B1224112) Merchant Name *: The name of the merchant. (e.g., TATAStore) Country : The country where the merchant is located. (e.g., India) Time Zone *: The time zone for the merchant's location. (e.g., (GMT +5:30) Calcutta, Madras, New Delhi) Currency : The currency used for transactions. (e.g., USD) Merchant Category Code : The category code for the type of merchant services provided. (e.g., Veterinary Services, Electrical Contractors, Horticulture Services) Min Payment Amount : The minimum payment amount allowed for transactions. Leave blank to specify an unlimited amount. (e.g., -2) Max Payment Amount : The maximum payment amount allowed for transactions. Leave blank to specify an unlimited amount. (e.g., [Enter the maximum payment amount]) Activation Status : Indicates whether the merchant account is currently active. (e.g., Active) Token Vault : Vault Name : The name associated with the token vault used by the merchant. (e.g., dapvault102) Users The Users tab in the Account Management section provides a comprehensive view of all users associated with a Customer, Level, or Merchant. The tab includes functionalities to add new users or existing users at each hierarchy level and displays user information in a tabular format. The table can be filtered and sorted by various criteria as discussed in the Display Filters and Grid Search Functionality Guide to help you quickly find the information you need. Functionalities Add User : This allows you to add a new user to the selected hierarchy level. Add Existing User : This allows you to add an existing user to the selected hierarchy level. User Details The user detail is displayed in a tabular format with the following information: Email : The email address of the user. (e.g., John@Doe.com) Name : The full name of the user. (e.g., John Doe) Parent Hierarchy : The parent hierarchy to which the user belongs. (e.g., Petron India) Status : The current status of the user. (e.g., Active) Last Activity Date : The date and time of the user's last activity. (e.g., 2024-05-02T13:34:46) API Keys The API Keys tab in the Account Management section provides a centralized place to manage API keys used for secure transactions. The tab includes functionalities to add new API keys at the Level and Merchant hierarchy levels and displays API key information in a tabular format. The table can be filtered and sorted by various criteria as discussed in the Display Filters and Grid Search Functionality Guide to help you quickly find the information you need. Functionalities Add API Key : This allows you to add a new API key to the selected hierarchy level. API Details The tabular format displays the following information for each API key: API Key : The unique identifier for the API key, partially masked for security. (e.g., 0046******0e33) Created By : The ID or name of the entity that created the API key. (e.g., 5c5859b7-6383-4481-8d64-c4e084a40e59) Created Date : The date when the API key was created. (e.g., 2024-03-26) Last Used Date : The date when the API key was last used. (e.g., 2024-05-10) Service : The services associated with the API key. (e.g., Hosted Checkout, Hosted Fields, Tokenization) Status : The current status of the API key. (e.g., Active, Inactive)
  • [Hierarchy Overview](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/hierarchy-overview.md): A Customer is represented by a hierarchy in Payment Orchestration. This Customer Hierarchy is comprised of different levels that allow the Customer to breakdown and represent their business as requried. It allows them to group create different groupings and put merchants into those groupings. This allows the customer to have some control over access to different grouings and can compile reporting based on groupings. The Hierarchy is made up of three types of elements: Customer - the top level element Level - Levels are the elements that allow the Customer to group merchants together. Levels can be further broken down into Sub-Levels. For example, levels could represent regions and sub-levels represent a city within a region. Merchant - Merchants are the elements that process transactions. These can represent physical branches, agencies, shops, etc. In the diagram above: Customer: A Demo Customer Levels: North Region, South Region Sub-Level: California (from North Region) Merchants: South Merchant 1, South Merchant 2, Notrth Merchant 1 User Access across the Hierarchy Where the user is added in to the hierarchy dictates the access that they have. A user will have access to the object they are allocate against and the descendants of that object. Using the diagram above: A user allocated against the Customer - A Demo Customer - will have access to all levels and merchants. A user allocated to a Level - e.g. South Region - will have access to that level and the two merchants that are connected to it. A User allocated to a merchant - e.g. North Merchant 1 - will only have access to that merchant. Inheritance in the Hierarchy The following is an overview of the types of properties and capabilites that can be inherited within the hierarchy. Inheritance works down the structure. More detials will be provided in separate sections. User Access The higher up the hierarchy the user is added, the more access they will have within the account. For example: a user allocated to the Customer will have access to all parts of the hierarchy, where as a user allocated to a specific merchant, will only have access to that merchant. Allocation of Services Service that are allocated on a level are made available, for selection, on the Merchant. For example: Acquirers selected against the Level, will be the only acquirers that can be selected against a Merchant under that Level. For Services to be enabled on a Merchant, they must be enabled on the level/sub-level immediately above it. If there are sub-levels in place then the Level, that they are “attached” to needs to have the services enabled, and then each sub-level needs to have the services enabled. Acquirers, APIs and Ecommerce services follow this inheritance rule. Smart Routing Rules Smart Routing Rules allow the Merchants to control which acquirers can process their transactions. They can use these rules to route specific transactions to acquirers that may provide better approaval rates, or more economical processing rates, to improve the profitability for the merchant. Smart Routing rules can be defined against Levels and Merchants. When a Smart Routing Rule is define against Level, and made active, when a merchant is added to that Level, it will inherit the active Smart Routing rule from the level and make it active. This is a way of providing a consistent Smart Routing rule new Merchants, under a level. Note: Smart Routing will be covered in more detail in a separate section.
    • [Customer](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/hierarchy-overview/new-section.md): Customer sits atop the Customer Hierarchy. It is the company, or Head Merchant, that owns/controls all the merchants that perform transactions for it. At this level we store the following details: This information is maintained by TNS.
    • [Level](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/hierarchy-overview/level.md): Levels can be used to logically group merchants together. For example, levels could be used to group merchants by division or geogrpahically. The Payment Orchestration user interface also makes use of the construct in dropdown selections, where the user can click on the level to select all the merchants underneath. Merchants sit under Levels. Levels can also have sub-levels, which can be used to provide additional grouping of merchants. The set up of the Level does influence the Merchants that sit underneath it. Across these tabs, there will be configuration that can be applied, or inherited by the Merchant. The “Tabs” that are available here, Details, Sercices, Smart Routing, etc. provide further configuration options. Later sections will cover these in further as they apply to Levels and Merchants. Where the usage varies it will be called out on in that section, as mentioned above, the configuraiton of the Level can affect the Merchants that sit underneath it.
    • [Merchant](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/hierarchy-overview/merchant.md): Merchants are the entities that process transactions.
      • [Merchant Overview](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/hierarchy-overview/merchant/merchant-overview.md): Accessible from the Overview tab, the Merchant Overview provides a snapshot of the merchant. It highlights some of the capability that has been enabled as well as some transaction based stats over the last 7 days. An example of the Merchant Overview. From the overview you can see the following: The Status of the merchant - Active or Inactive. Timezone the merchant operates within. Currency the merchant uses. Information on the number of Acquirers, Equipment and Terminals the Merchant has available to it. The Ecommerce section highlights any Ecommerce capability that has been activated for the merchant. Options that are functioning will be in colour, not greyed out. Smart Routing, eReceipt and Notifications have indicators identifying if they are Enabled or Disabled. For Smart Routing the indicator will display enabled if Smart Routing rules have been set up. For eReceipt and Notification, their respective indicators will display they are Enabled, if they have been made configured and made Active via their links in the Miscellaneous section of the Services tab. Two report widgets are displayed: (Transaction) Count by Card Type (Transaction) Volume by Date. It reports on transactions in the currency for the Merchant. Both reports are produced for the last 7 days.
  • [Smart Routing](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/smart-routing.md): Smart Routing provides the merchant with a level of control over the processing of a transaction by applying rules. Rules can be create to direct transactions to specific acquirers for processing based on details and attributes of the transaction. This way the Merchant can take direct transactions with specific attributes to an acquirer more favourable for approval or with a better cost/transaction rate. This will allow merchants to improve their trnsaction approval rates and lower their transaction costs. Example of a Smart Routing Rule with paths to different acquirers based on different attributes of the transaction. Smart Routing rules are constructed on the Smart Routing Canvas using a set of Nodes. The nodes are joined together by arrows, that direct the flow of the transaction. The rules can form divergent paths, allowing for multiple outcomes depending on the attributes of the transaction. Most Nodes have a Primary Path and a Fallback Path - these act like an IF/Else decsion point, but diagramatically. The nodes can be set up with specific conditions. When a transaction passes through that node, if it meets those conditions - it will take the Primary Path, otherwise it will take the Fallback Path. The Paths need to end in Final Node - one that identifies the Acquirer the transaction wil use. The Nodes provide the logic that can be used to direct the flow of transactions to specific acquirers. Smart Routing rules need to be activated to have an affect on the processing of transactions. Only one rule can be active at any point in time for a Merchant. The effect of Smart Routing on a transaction can be seen on the Transaction Details screen. This screen viewed by selecting to view a transaction from the Transaction Report or via the Transaction - Manage Transaction screen where you can select to view the transaction. On that screen is a section for Smart Routing, that calls out the name the Routing Rule and the logic it used to derive the resulting Acquirer. Example of Smart Routing Detail on Transaction Detail screen The above is an example taken from a transaction from the Test environment. It shows the Smart Routing detail that was used for determining the Acquirer.
    • [Nodes](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/smart-routing/nodes.md): There are a variety of Nodes available for constructing Smart Routing rules. Nodes are connected together by links. The links direct the flow, based on the conditions set up on the nodes. When connecting the nodes, links are connected to the Node Entry Point, represented by a small square centred on the lefthand border. Unless otherwise stated, each node has a Primary Path and a Fallback Path. The Primary Path is identified by a small circle centred on the righthand border of the node. The Fallback Path is identified by a small circle centred on the lower border of the node. Outgoing links need to be connected from these points to the next node. Node Entry Point and Outward Points for Primary Path and Fallback Path. Nodes can be selected from the lefthand menu of the Smart Routing canvas. They need to be dragged onto the canvas to be set up. Title Card Type This node allows you select the schemes you want to send down the Primary Path. Click on each of the schemes, a tick will appear on the top righthand corner of the scheme icon, when it has been selected. Any transaction for a scheme that is not selected will head down the Fallback Path. Amount This node allows you to compare the amount of the transaction to direct the flow. The comparison is done with the actual transaction amount, regardless of currency. The operators available are: Greater Than, Less Than, Equals, Between. Card BIN This node allows you to compare the card's BIN, from the transaction, to the conditions set up by the on the node. The operators available are: Equals, Between, List and Starts With. Card AID This node allows you to compares to the card's AID (Application Identifier), which can be used to identify card types, to the conditions set up on the node. The operators available are: Equals, List, Starts With. Date Time Range This node allows the user the determine the time different paths are available. A use case could be to use different acquirers at different times. This node allows up to three time schedules. Each Time Schedule acts as an “OR” conditions, if a transaction satisfies any of the Time Schedules, the transaction will be passed to the Primary Path, otherwise it will pass to the Fallback Path. Each Time Schedule is made up of: A Start Date and End Date over which the time schedule is effective. The days of the weeks, which can be selected individually, to indicate the days that are valid for the Time Schedule. The Start Time and End Time, applied to each selected day that the time schedule is effective. Satisfying all these conditions for the Time Schedule will send the transaction to the Primary Path. Additional Time Schedules can be added to the node by the Add Recurrence button and deleted from the node by clicking the Bin icon (see image below). There must always be at least one Time Schedule on the node. Payment Channel This node allows the user to select the payment channel, the method used to initiate the transaction, to direct the transaction down a specific path. There are three options: Terminals Ecommerce Alternative Payment Methods The user needs to click on an option to select it. The transactions meeting the selected option will take the primary path. Notes: All options selected will be routed to the Primary Path. Be aware if you select more than one, they will head down the same path. If you want to differentiate between two options, applying a second Payment Channel Node will allow you to split the channels to different paths. For the Alternative Payment Methods - only Apple Pay and Google Pay, when used during an Ecommerce transaction, can be actioned by this selection option. When Alternative Payment Methods is selected Apple Pay and Google Pay will be routed to the same path. Payment Attributes The Attributes Node allows users to direct transactions down the Primary Path where they align to attribute/value sets that can be defined on the node. There are many different Attributes that can be selected from the Select Attributes dropdown menu. Click the checkbox of the Attribute to select it. The are a number of different Attributes that can be selected. Notes: Each Atrtribute is provided with a set of values to select from. Where an Attribute has many values to chose from, multiple values can be selected. They act as an Or condition - if any of the selected values match for the Attribute, that Attribute/Value pair will be interpreted as satisfied and can route the transaction to the Primary Path. Selecting multiple Attributes will have them acting as an Or condition. If any of the Attribute/Value pairs are satisified, the transaction will be routed to the Primary Path. If none of the Attribute/Value pairs are satisified, the transation will be routed to the Fallback Path. To remove a selected Attribute from the Node, untick the check box from the Select Attributes dropdown menu. You can select up to three Attributes per Attribute Node. If you want to select more, you can add extra Attribute Nodes, however they act as an AND condition. The transaction will have had to satisfy the previous node to get to the next one. Care must be taken to ensure you achieve the logic you expect. Payment Metadata The Payment Metadata Attribute allow users to direct transactions to the Primary Path successful evaluation of Metadata. Metadata can be set up against transactions, when the transactions are captured and processed. This Node is able to interpret the Metadata, entered as Key/Value pairs, and evaulate against it to provide routing instructions. Note: The Metadata Key and Values are case-sensitive . Be careful case is important here. The Metadata Key/Value combinations work as Or conditions. If the Transaction satisifies any of the conditions, it wil be routing to the Primary Path.The Operators available are: Equals Starts with Contains Exists - no value is required for this. The evaluation is testing for the existence of the Metadata key regardless of value. A list of values can be entered for a Metadata Key by pressing Enter, allowing you to add another. It is also possible to Cut & Paste a set of values from the clipboard or a text editor - where each value appears on a separate line.New tabImage captionAlternative text Notes: Metadata Key/Value options can be removed by clicking on the Bin icon next to it. A Value can be removed by clicking the small “x” next to it. Acquirer This node allows the user to select the Acquirer that will process the transaction. Note : This is a Final Node - it will end a Smart Routing path. If the transaction reaches this node, the Acquirer selected will process the transactions. The Acquirers available for selection will be the active Acquirers for the Merchants. Block Transaction This node will prevent the transation from being processed. Note : This is a Final Node. You can use this to finish a Smart Routing path where you do not want to accept the transaction. The transaction will be declined with response code: ???? The node can be removed from the canvas by clicking the “X”. Nodes coming in later releases Title Description Volume Distribution Volume Distribution allows the user to distribute transactions over multiple outward paths based on percentages. The node start out with one path. Addiitonal nodes can be added by clicking the Add Path button. Up to five paths can be added to a Volume Distribution node. Paths can be deleted by clicking on the Bin icon next to it. Each path gets its own Outward point that can then be attached to other nodes. The distribution is random. Each time node is hit, it will randomly chose which path to send the transaction down. The chances of that happening is based on the percentage allocated to the path. In the example above - 75% will be directed to Path 1, 10% to Path 2 and 15% for Path 3. This node has no Fallback path - each outward point maps to a path. Decline Rate The Decline Rate node allows the user to route based the rate of declines for the selected Acquirer. This node allows merchants to route transactions differently if an acquirer, they use is declining transactions at a rate that is higher than expected. This is not a Final Node. The Decline Rate can be determined via a number of factors: Measured by: Acquirer - this is looking at all declines across the acquirer, regardless of Merchant. Merchant - this is looking at transactions for the merchant declined by the Acquirer. Min. Transaction Volume: this provides the a minimum volume of transactions to determine the Decline Rate, allowing for a statistically meaningful calculations. Measurement Time Window: the (rolling) duration over which the calculation is performed. Acquirer: the Acquirer the Decline Rate will be monitored for. The Decline Rate is the Number of Declined Transactions/Number of Transactions for the time period. The Max. Decline Percentage is the setting that controls whether to send the transaction to the Primary or Fallback Path. If the Decline Rate is below the Max. Decline Rate the node will route to the Primary Path, otherwise the Fallback Path. Response Time The Response Time node checks the response time if the selected Acquirer and if that is does not exceed the Max. Acquirer Response Time, the transaction will be routed to the Primary Path, otherwise it will be routed to the Fallback Path. Note: This is not a FInal Node. The Primary and Fallback paths will need to end in FInal Nodes. The Acquirer Response Time is calculated as an average over a (system wide) rolling time period. This average can vary over time. The Acquirer is selected from the list of acquirers enabled for the Merchant. Acquirer Availability The Acquirer Availability node allows the user to define a Fallback Acquirer is the Primary Acquirer is unavailable. Payment processing will immediately attempt the transaction with the Fallback Acquirer if the Primary Acquirer is unavailable. The Primary and Fallback Acquirers can be selected from the Acquirers available to the Merchant. The Primary Acquirer and Fallback Acquirers cannot be the same. This node will use historical data to determine if the Primary Acquirer is available, to save an attempt of the transaction on the Primary. If the Primary Acquirer has been unavailable for a period of time, the node will hold off using the Primary, sending transactions direct to Fallback Acquirer, and regularly check if the Primary has recovered. If it has, processing returns to normal. Note: This is a Final Node. The Primary and Fallback Acquirers defined onthe node at the end of the routing path. Debit Routing The Debit Routing node allows the user to route transactions from Debit cards. If the transaction is performed from a Debit Card, the transaction will be routed to the Primary Path, otherwise it will take the Fallback Path.
    • [Evaluate Rules](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/smart-routing/evaluate-rules.md): The Evaulate Rules option allows a user to test the Routing Rule that has been designed, by entering Transaction Data, that would be evaulated by the rule to see what the result would be. This allows the user to test scenarios and adjust the rule logic, if necessary, to achieve their desired outcome. Evaluate Rules operates on the rule being edited. To evaluate the rule: Enter the transaction data. Click Evaluate . The result will be presented at the top of the screen. For example: Clicking Reset will reset all the fields so the user can start again.
    • [Smart Routing Tips](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/smart-routing/smart-routing-tips.md): The following are tips to for constructing Smart Routing Rules Only one Active rule can exist for a Merchant at any point in time. All Smart Routing paths must end in a Final Node so that the transaction can be processed. Circular paths are checked for during save and if detected and error message will be displayed. Circular paths can occur if a link connects back into an earlier node in the rule path. If a cicular path was in place, Smart Routing is at risk on getting into a loop and the transaction never being processed. An error - Invalid routing path detected. - will appear on one of the nodes impacted. A node can have multiple inward links, but only one outward link for each of its outward paths. All paths must end in a Final Node for the Routing Rule to be valid. Apart from a Final Node and the Entry Point, all nodes must have at least one inward link and one outward link/output path. An “Orphaned” node will prevent the Routing Rule from saving. To make the paths easier the follow, work from left to right, from the Entry Point node to the completion of all the paths. Try not to cross paths as you construct the rule, as this can lead to confusion when viewing the rule.
    • [Metadata](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/smart-routing/metadata.md): Metadata are merchant-defined fields passed in the transaction request and stored against the transaction record for display and reporting purposes. M etadata is stored as custom key-value pairs attached to a transaction at submission time (via Payment Endpoints, PayCore, or Hosted Checkout). These can be use to help categories the transaction as they can be used to represent somehting meaning full to the merchant about the transaction at the time of submission. Metadata can be used by the Metadata Smart Routing node to route transactions. Further information on setting up Metada can be found in the TNS Developer Portal. Metadata Constraints Here are constraints applied to the setting up of Metadata. Name (key): max 100 characters, case-sensitive Value: max 500 characters, case-sensitive Single-level only — no nested metadata objects Duplicate keys allowed — metadata is stored as a list, not a map No additional validation is performed on metadata content Viewing Metadata Metadata can be viewed in the following areas: Transaction Reporting - if the result of a Transaction Report contains metadata, Display Fields will enable a Metadata option, which when ticked will display the Metadata. THis also works for the transaction list presented in Manage Transactions. Transaction Details -Through Manage Transactions - select the transaction and via the three dot menu select Transaction Detail. Under the Details tab, if metadata is present it will appear within the Metadata section of the transaction. If there is no metadata present, no Metadata section will appear on this screen.
  • [Webhooks](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/webhooks.md): Merchants can now subscribe to webhooks to receive event notifications (e.g. transaction approved, declined etc) pushed to their own backend server endpoint. Webhook Notifications deliver real-time HTTP POST callbacks to your server when payment events occur on the TNS Payment Orchestration platform. Instead of polling for transaction status, your system receives instant notification when a payment is approved or declined. Currently this is limited to Transaction Events - Approvals and Declines. Webhooks push data about these events to an endpoint. Systems that are listening to that endpoint can receive the data and perform their own processing on it. Webhooks could be used to prompt processes on these external systems. Note: After 5 consecutive webhook delivery events which fail, the webhook will be disabled. Further technical information can be found in the Developer Portal: https://developer.pay.tnsi.com/ Webhook Setup It's a two-step process: Setup Webhook Notification API Add a Webhook Endpoint Webhook API Setup To be able to use this, the Merchant must have the Webhoook Notifications API available to it. The Webhook Notifiations API needs to be enabled in in the (parent) Level the Merchant is attached to and then added to the Merchant. API Keys must be added to the Webhook Notifications. The API Key and Secret act as the credentials to authenticate the data. API Keys are added through the existing API Key functionality. Add Webhook Endpoint To add new webhook endpoint, click the Webhooks tab on the Account Management screen. The tab presents the + Add Endpoint button as well as the list of existing endpoints set up for the merchant. Click the + Add Endpoint button. A new window will display to setup the Endpoint Details. Title Description Add Endpoint screen - data to be entered. Add Endpoint screen - data entered (Approved Category selected) Fields for entry: URL : The address of the endpoint the data notification will be sent to. Display Name : A friendly name for the Endpoint. Use this to give the endpoint a meaningful name. API Key : Select the API key relevant for this Endpoint. Subscribed Categories : Pick at least one category - Approved or Declined. All the fields are mandatory. Click Save when complete. After saving the Endpoint it will appear on the table: Managing Webhook Endpoints Webhooks can be managed from the table. The t hree dot menu enables the following options: Edit : Allows the user to edit the setup of the Webhook. Test : Allows the user to send test data to the webhook endpoint. This allows the user to test the setup of the receiving system. After setting up the endpoint, Testing it wil send a test notification to that endpoint. Deactivate : Allows the user to deactivate Active webhooks. Once deactivated, the webhook will not be sent any data. Activate : Allows the user to activate Inactive webhooks. This will make the Webhook active again and recommence sending data to the webhook endpoint. Delete : Allows the user to delete the webhook.
  • [Manage API Keys](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/manage-api-keys.md): The API Keys tab allows you to manage the API keys associated with your Customer, Level or Merchant account. API keys are essential for integrating various services and ensuring secure communication between different systems. This guide will walk you through the steps to view, and generate new API keys. Viewing API Keys The API Keys tab provides a comprehensive view of API keys associated with the selected Merchant or Level. To view API keys, navigate to the Account Management section from the main menu and select the appropriate Customer, Level, or Merchant level from the Hierarchy Selector. The following information is displayed in a tabular format for each user that can be filtered and sorted by various criteria as discussed in the Display Filters, Grid Search, and Pagination Guide to help you quickly find the information you need. API Key : The unique identifier for the API key, displayed in a partially masked format for security (e.g., 1816******b2f4). Created By : The ID or name of the entity that created the API key. Created Date : The date when the API key was generated. Last Used Date : The date when the API key was last used. Service : The services associated with the API key (e.g., Payments, Tokenization, Hosted Checkout). Status : The current status of the API key (e.g., Active, Inactive). In the diagram above, there is a Copy icon between the API Key column and the Created By column. Clicking this icon copies the complete API Key. Adding a New API Key To generate a new API key, perform the following steps: Select the appropriate Customer, Level. or Merchant from the Hierarchy Selector under which the user has to be added. After selecting the object in the hierarchy, click on the API Keys tab. Click on the Add API Key button. This will expand and open the API Key Generator section. 4. Choose the Featured Services you want the API key to have access to by selecting from the following checkboxes: Card Not Present API's - these API cover Ecommerce type transactions. Other Services - these APIs cover APIs not specific to card transactions. Tokenization - this API covers the TNS tokenization capability. Card Present API's - these API cover Terminal capability. This list can vary based as it is based on the APIs that have been selected for the object in the hierarchy. 5. Click the Generate Key button to create the new API key. 6. A modal window pops up with the newly generated API key and a secret. You must copy and save these details as the secret is not retrievable after you close the window. C lick Copy next to each key to save them for future reference. API Key : The generated API key (e.g., 397b53432fa8a5c42c3a1ae0787b9845b3082afa******************). Secret : The secret key (e.g., KIxo3BMJDqF9VEaa/w9bEzcHnfP2kWYiC2*********). By following these steps, you can efficiently generate and manage API keys, ensuring secure and effective integration with your merchant services. Edit API Key To edit an API key, perform the following steps: Select the API Key that needs editing from the grid. Click the Edit button from the three dots . This will expand and open the Edit API Key section. Choose the Featured Services you want the API key to have access to by selecting from the following checkboxes: Card Not Present APIs Other Services Tokenization Card Present APIs Note: This list can vary based as it is based on the APIs that have been selected for the object in the hierarchy. Click the Update button to save the new API key details. Deactivate the API Key Deactivating an API key will revoke access to all services that use the key. To deactivate the key, from the grid, select the API Key and from the three dots , click Deactivate . You will be presented with a modal, to giving you the opportunity to back out of this action or go ahead with the deactivation. Click Deacticate API Key to deactivate the key. The Status of the key will change to Inactive. Click Cancel to return to the API Key grid and not deactivate the key. Activating an Inactive API key If you need to make an Inactive API Key active again, from the three dots click Activate . The API Key will be immediately made active and the status will also change to Active.
  • [Manage Users](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/manage-users.md): The Users tab in Account Management lets you manage users within your Customer, Level, or Merchant accounts. You can view and create new user profiles, and edit user details as needed. This section provides the necessary tools to ensure that the right people have the right level of access to your merchant account. Viewing Users The Users tab provides a comprehensive view of all users associated with a Customer, Level, or Merchant. To view user details, navigate to the Account Management section from the main menu and select the appropriate Tenant, Level, or Merchant level from the Hierarchy Selector. The following information is displayed in a tabular format for each user that can be filtered and sorted by various criteria as discussed in the Display Filters, Grid Search, and Pagination Guide to help you quickly find the information you need. Email : The email address of the user (e.g., John@doe.com). Name : The full name of the user (e.g., John Doe). Parent Hierarchy : The parent hierarchy to which the user belongs (e.g., Local Merchant). The user has no access above the Parent Hierarchy. Role : The role(s) that the user has been assigned. Roles define the permissions that a user has. A User may have more than one role. Last Activity Date : The date and time of the user's last activity (e.g., 2024-05-20T07:13:35). Status : The current status of the user (e.g., Active, Inactive). Adding a New User To add a user to the hierarchy, perform the following steps: 1. Select the appropriate Customer, Level or Merchant from the Hierarchy Selector under which the user has to be added. 2. After selecting the place in he account hierarchy, click on the Users tab. 3. Click Add New User . A window slides from the right screen with fields for entering the user details. 4. Fill in the User Details : Enter the full name of the user. Enter the user's email address. 5. Select applicable Regions supported. 6. Assign Roles to the user from the available options, such as finance, clerk, admin, developer, operation, and call center. The roles provide the user with the permssions to perform their role. 7. After filling in all the required fields, click the Save button to add the new user. Note: All these fields are mandatory. You will not be able to save the user unless these fields have been populated. Adding an Existing User To add an existing user to the hierarchy, perform the following steps: 1. Select the appropriate Customer, Level. or Merchant from the Hierarchy Selector under which the user has to be added. 2. After selecting the hierarchy, click on the Users tab. 3. Click Add Existing User . A window slides from the right screen with a list of existing users. 4. Select the checkbox for the user that has to be added. If there is a large list of users, you can click the Filter button, immediately above the User table, which will provide a filter entry field for each column in the table that can be used to filter the rows. You can use this locate the user you are interested in. 5. Click Save to add the existing user to the hierarchy. Edit User You can change the properties of a user, including disabling them, by editting a user. You can edit a user by clicking the three dots against the user and clicking Edit User. By clicking on Edit User , the Edit User page will be presented on teh right-hand side of the screen. There, you can access and update the user details, roles, and status for that specific user as illustrated below. Editing User Details comprises of three sections - User Details, Roles and Status. A fourth section, Payment Configurations, will be available for users with roles: Admin, Call Center or Operations. Full Name: Specify the Full Name of the User Email Address: The email address cannot be edited. Roles: Specify the role of the User Status: Click the checkbox to make the user Inactive (deactivated) Payment Configuration Max Payment: Specify the Max Payment for the User Max Refund: Specify the Max Refund for the User Note: you can see when the user was last logged in within the Status section. Deactivating a User There are two ways to deactivate a user: From the User table - click the three dots and click Deactivate . Edit the User and set their Status to Inactive.
  • [Display Filters, Grid Search, and Pagination](https://developer.pay.tnsi.com/merchant-portal-user-manual/account-management/display-filters-grid-search-and-pagination.md): This document provides an in-depth explanation of the display filters and grid search functionality available within the Merchant Portal. These features allow users to customize and search the table data efficiently across various sections, including account management, transaction management, reporting, and more. Display Filters Display filters allow you to customize the table data as per your preference. You can apply the following filters: 1. Display Fields: Click the Display Fields dropdown to customize the display fields in the table by selecting the appropriate checkboxes. The table data are generated based on the selected fields. 2. Order By: Click the Order By dropdown and select the appropriate checkboxes to generate table data in the order of the selected checkbox. 3. Sort By: Click the Sort By dropdown and select Asc or Desc to populate table data in ascending or descending order based on the selection. These filters provide flexibility in how the data is displayed, allowing you to focus on the most relevant information for your needs. Grid Search Functionality The grid search functionality allows you to search and filter data directly from the grid displayed on various pages, such as the Search Transactions page. This functionality is available for all grids within the application, enhancing the ease of finding specific information. Using the Grid Search You can search for specific data within the grid by clicking on any column name. This action opens a search field within the column header where you can enter your search criteria. Upon hitting enter, the grid updates to display the results based on the search input. Steps to Use Grid Search Navigate to the page containing the grid (e.g., Transactions Report). To search for specific data within the grid: Click the Filter button. Click on the column name where you want to perform the search (e.g., Merchant , Card Number ). A search field appears in the column header. Enter the search criteria in the field and hit enter. The grid updates to display the results based on your search input. This grid search functionality enhances the ease of finding specific transactions or report entries by allowing direct filtering within the displayed data. Example - Transactions Report To illustrate how to use the grid search functionality, consider the following example for searching transactions related to a specific Card Type: Navigate to the Transaction Report, within the Reports (Main Menu). Run the report. Click on the Filter button. This will present the search fields under each eligible column. Enter a Card Type, for example: Visa, into the Card Type seach field. Press Enter 6. The search runs returning all the rows with Card Type equal to Visa. By using this feature, you can quickly locate and analyze specific transactions or report entries, making transaction management and reporting more efficient. Pagination Pagination is an essential feature in the Merchant Portal that helps you navigate through large sets of data efficiently. Whether you are viewing transaction search results, report data, user data, token data, or any other extensive tabular list, pagination divides the results into smaller, manageable pages. This ensures that the information is accessible and easy to see without being overwhelmed by a large volume of data at once. Understanding Pagination Controls The pagination controls include the following elements: Entries Info : Displays the range of entries currently being viewed and the total number of entries available. For example, "Showing 1 to 10 of 50 entries" indicates that the first 10 entries out of 50 are currently displayed. Page Navigation : Includes buttons to navigate through the pages of results: First Page Button (<<) : Navigates to the first page of the results. Previous Page Button (<) : Navigates to the previous page. Page Numbers : Allows direct access to specific pages. Clicking on a page number (e.g., 1, 2, 3, etc.) will display the entries for that page. Next Page Button (>) : Navigates to the next page. Last Page Button (>>) : Navigates to the last page of the results. Entries Per Page Dropdown : Allows you to select the number of entries displayed per page (e.g., 10, 20, 30, and 50). This dropdown is useful for adjusting the number of entries you want to see at a time. By using these pagination controls, you can efficiently navigate through any set of data, making it easier to locate and analyze specific entries without being overwhelmed by a large volume of information.
• [Terminal Management](https://developer.pay.tnsi.com/merchant-portal-user-manual/terminal-management.md): The Terminal Management section enables you to create reports using different selection criteria. Within these reports, you can view terminal and merchant links, as well as additional details such as equipment, terminal model, acquirer and more. Generate Terminal Management Report To generate the terminal list, perform the following steps: Select the merchant for whom the terminal list will be generated from the Merchant dropdown menu. You can select multiple merchants from the list. Select acquirer from the Acquirer dropdown menu if you want to filter based on the acquirer. Select equipment from Equipment dropdown menu if you want to filter based on the equipment. Select terminal make from the Terminal Make dropdown menu if you want to filter based on the terminal make(eg., Ingenico, PAX). Select terminal model from the Terminal Model dropdown menu if you want to filter based on the terminal model. Enter terminal name in the Terminal Name field for searching specific terminal with name. Enter terminal id in the Terminal ID field for searching specific terminal with ID. Enter serial number in the Serial Number field for searching specific terterminal with serial number. Select terminal type form the Terminal Type dropdown menu if you want to search based on specific terminal types (e.g. Attended, Unattended, Both). Enter last message received in the Last Message Received field for specific search criteria. Select P2PE Enabled checkbox if you want to filter terminal having P2PE feature enabled. Enter PCI PTS version value in the PCI PTS Version field for specific search. Enter EMV contact l1 version in EMV Contact L1 Version field for specific search. Enter EMV contactless l1 version in EMV Contactless L1 Version field for specific search. Enter EMV contact l2 version in EMV Contact L2 Version field for specific search. Enter EMV contactless l2 version in EMV Contactless L2 Version field for specific search. Enter the terminal request date in the Terminal Request Date field (e.g., May 19, 2024). Enter the last activity date of the terminal in the Last Activity Date field (e.g., May 19, 2024). Select a status from the Status dropdown menu(e.g. All, Online, Offline, Enabled, Disabled, Provisioned, No Activity). You may select multiple options from the list. After filling in all the required fields and selecting any optional filters, click the Run Search button to generate the list. Search Result Terminal ID: Internal ID of the terminal listed. Merchant: Merchant Name assosiated with the terminal ID. Acquirer: Name of the acquirer assosiated with the terminal. Certificate: Terminal certificate name. Equipment: Assosiated equipment for the terminal. Terminal Make: Terminal make e.g. Ingenico/PAX Terminal Model: Terminal model number Terminal Name: Name of ther terminal in the system. Serial Number: Serial number of the terminal (if available). Terminal Type: Type of the terminal e.g. Attended, Unattended, Both. Terminal Request Date: Date when the terminal was requested. Last Activity Date: The date when the terminal was last active. Status: Terminal status e.g. All, Online, Offline, Enabled, Disabled, Provisioned, No Activity). EMV Contact L1 Version : Version number of the EMV contact L1. EMV Contact L2 Version: Version number of the EMV contact L2. EMV Contactless L1 Version: Version number of the EMV contactless L1. EMV Contactless L2 Version: Version number of the EMV contactless L2. PCI PTS Version: PCI PTS version of the terminal Last Message Type: Type of message received last from the terminal. Utilizing Search Results By analyzing the search results, you can monitor and review terminal and assosiated values.. Sorting and filtering options help you narrow down the results to find specific data quickly. Clicking on every Terminal ID from the list will open Terminal Details page, where you can find more specific information about the terminal.
• [Transaction Management](https://developer.pay.tnsi.com/merchant-portal-user-manual/transaction-management.md): The Transaction Management section provides tools to manage and perform various types of transactions within the merchant portal. By navigating to the Transactions section, you will find two main options: Manage Transactions and Perform Transactions . These features allow you to search for specific transactions, apply filters, and execute different types of transactions such as sales, authorizations, and refunds. This section helps you effectively oversee and execute your transaction-related activities, ensuring smooth and secure processing of payments. Manage Transactions The Manage Transactions feature allows you to search for and manage existing transactions. You can apply various filters to narrow down your search results and view detailed information about each transaction. This feature is essential for monitoring transaction history, and maintaining accurate records of all transactions. Perform Transactions The Perform Transactions feature enables you to initiate and process various types of transactions directly within the merchant portal. Whether you need to perform sales, authorizations, or refunds, this feature provides a streamlined process to ensure that all transactions are handled efficiently and securely. By entering the required transaction details and selecting the appropriate options, you can execute transactions with ease. Pay By Link Transactions Pay By Link is a new payment method that allows merchants to generate a payment link and send it to customers (via email, SMS, etc.) to complete payment on a hosted page. Pay bu Link needs to be configured against the Merchant for the option to be available.
  • [Manage Transactions](https://developer.pay.tnsi.com/merchant-portal-user-manual/transaction-management/manage-transactions.md): The Manage Transactions section allows you to search for and manage existing transactions within the Merchant Portal. You can filter transactions by various criteria such as merchant name, date range, card type, and more. This section provides detailed information on each transaction, enabling you to monitor and review transaction history effectively. Advanced filtering options help you narrow down your search results, making it easier to find specific transactions and view comprehensive details. Searching Transactions To search for a transaction, perform the following steps: 1. From the main menu bar, navigate to Transactions . 2. Click Manage Transactions under Transactions. The Search Transactions page displays. 3. Use the search fields to: - Select the merchant from the Merchant dropdown. - Select the Start Date and Time . - Select the End Date and Time . - Select the Date Type (e.g., Date Effective, Date Authorized, Date Settled). - Date Effective: The date on which the transaction is considered to have taken place. - Date Authorized: The date when the transaction received approval from the payment processor. - Date Settled: The date when the transaction funds are transferred to the merchant's account. - Select the Currency (e.g., AUD, BRL, EUR, USD etc). 4. Click View More and fill in other relevant data in the respective fields further discussed in the Advanced Filtering section. 5. Click Run Search to view the results. Advanced Filtering The advanced filtering options help you narrow down your search results, making it easier to find specific transactions and view comprehensive details. Selecting the View More button on the Seach Transaction page displays the advanced filters. The available filter options include: Card Number : Filter by the card number. First 6 : Filter by the first six digits of the card number. Last 4 : Filter by the last four digits of the card number. Card Type : Filter by the type of card used in the transaction, such as Visa, MasterCard, Amex, Diners, etc. Entry Mode : Filter by the method used to enter the card details, such as E-commerce, EMV Contact, EMV Contactless, EMV Fallback, Magstripe, and Keyed. Status : Filter by the current status of the transaction, such as Approved or Declined. Transaction Type : Filter by the type of transaction, such as Sale, Authorization, Capture, Refund, Standalone Refund, Reversal, Void and Account Verification. Mode : Filter by the mode of the transaction, such as Online, Offline - Deferred Authorization, and Offline. Receipt Number : Filter by the transaction's receipt number. Agreement ID : Filter by the agreement ID's. Auth Code : Filter by the authorization code. Response Code : Filter by the response code received from the acquirer. Transaction Amount : Filter transactions based on the transaction amount. Configured Acquirers : Select the acquiring bank or processor configured in your account, such as FISERV US. RRN Number: Filter by the Retrieval Reference Number. TNS Terminal ID : Filter by the TNS Terminal ID associated with the transaction. Search Transactions Results After performing a search, the Search Transactions page displays the results in a tabular format. Each row in the table represents a transaction, and the columns provide specific details about each transaction. The table can be filtered and sorted by various criteria as discussed in the Display Filters, Grid Search, and Pagination Guide to help you quickly find the information you need. Below is a detailed explanation of the columns you will find in the search results table: Merchant : The name of the merchant associated with the transaction. Authorized Date/Time : The date and time when the transaction was authorized. This is displayed in the format "Day Month Date Year Time GMT+Timezone (Timezone)". Card Number : The card number used in the transaction. For security reasons, only the first six and last four digits of the card number are displayed (e.g., 444433******1111). Card Type : The type of card used in the transaction, such as Visa, MasterCard, etc. Entry Mode : The method used to enter the card details, such as E-commerce, EMV Contact, EMV Contactless, Magstripe, Keyed, etc. Status : The current status of the transaction. Common statuses include Approved or Declined. Transaction Type : The type of transaction, such as Sale, Refund, Authorization, Reversal, etc. Mode : The mode of the transaction, which can indicate the environment or platform used (e.g., Online, Offline). Response Code : The response code received from the acquirer, indicating the result of the transaction. Common codes include 000 for approved transactions and specific numerical codes for declined transactions. Transaction Amount : The amount of money involved in the transaction. TNS Terminal ID : The Terminal ID associated with the transaction. Agreement ID : Agreement ID associated with transactions. Payment Channel : The payment channel used for the transaction, such as PayPal, Credit Card, etc. Receipt Number : The unique receipt number assigned to the transaction. Utilizing Search Results By analyzing the search results, you can monitor and review transaction history effectively. Sorting and filtering options help you narrow down the results to find specific transactions quickly. For example, you can sort the results by Authorized Date/Time to see the most recent transactions first, or filter by Status to view only approved or declined transactions. Understanding the detailed information provided in each column allows you to: Verify transaction details and status. Identify patterns or anomalies in transaction data. Ensure accurate record-keeping and reporting. By leveraging these search and filtering capabilities, you can efficiently manage your transaction history within the merchant portal.
  • [Transaction Options](https://developer.pay.tnsi.com/merchant-portal-user-manual/transaction-management/transaction-options.md): When you click on the three dots corresponding to each transaction, a menu with different options is displayed. These options allow you to perform various actions on the transaction. The available options may vary depending on the transaction status and type. The options typically include: Transaction Details : View detailed information about the transaction. Refund : Initiate a refund for the transaction. Void : Cancel the transaction. Capture : Capture the authorized amount for the transaction. Only available for approved Auth transactions. Generate eReceipt : Generate a receipt for a transcation. Transaction Details To check the details of a transaction, perform the following steps: 1. Click the three dots next to the transaction. 2. Select Transaction Details from the menu. 3. The Transaction Details page displays comprehensive information about the transaction. Detailed Information on the Transaction Details Page The Transaction Details page includes several sections providing various details about the transaction. Below is a breakdown of the information available: Transaction Type : The type of transaction (e.g., SALE). Transaction Amount : The amount involved in the transaction (e.g., USD 501.00). Transaction Status : The current status of the transaction (e.g., Approved). General Information TNS Merchant ID : Unique identifier for the merchant (e.g., 102606). Client Reference : Client-specific reference number. TNS Reference Number : Unique reference number assigned by TNS (e.g., 24568336-e780-48f6-b616-1ac73b9ca22f). Entry Mode : Mode of entry for the transaction (e.g., ECOMMERCE). Payment Channel : The payment method used (e.g., Credit Card). Transaction Initiator : Who initiated the transaction (e.g., Merchant). Transaction Information Some of the fields will only be presented if their value is not zero. Response Text : The response message for the transaction (e.g., Transaction Approved). Auth Code : The authorization code for the transaction (e.g., 104342). Receipt Number : The receipt number (e.g., HE1W1S). Response Code : The response code (e.g., 00). STAN : System Trace Audit Number (e.g., 367770). RRN : Retrieval Reference Number (e.g., f3902a9c-****-4596-9059-0476f6c10c1c). Approved Amount : The amount approved (e.g., $501.00). X Request : Request identifier (e.g., e0043aac-e95f-9c76-a562-54c881a8831d). Surcharge Amount : The surcharge amount (e.g., $0.00). Tax Amount : The tax amount (e.g. $0.00) Sub Total : The Sub Total amount (e.g. $501.00). This value does not contain the surcharge. Total Amount : The total amount involved in the transaction (e.g., $501.00). Transaction History Transaction ID : Unique identifier for the transaction (e.g., 24568336-****-48f6-b616-1ac73b9ca22f). Transaction Type : Type of transaction (e.g., Sale). Transaction Date : Date and time of the transaction (e.g., 2024-07-20 14:07:35). Payment Channel : Payment method used (e.g., ECOMMERCE). Amount : Amount involved in the transaction (e.g., $501.00). Transaction Status : Current status of the transaction (e.g., Approved). Credit Card Information Token : Token associated with the credit card (e.g., 74553****7089004). Card Type : Type of credit card (e.g., Visa). Card Number : Masked card number (e.g., 499977******9004). Expiry Date : Expiry date of the card (e.g., 10/26). Device Information Tender Type : Type of tender (e.g., CREDIT). Acquirer Details Acquirer Details : Information about the acquirer (e.g., FISERV AU). Acquirer Merchant ID : Merchant ID assigned by the acquirer (e.g., fc56de02-****-4296-8f54-63a76586db0e). Additional Authentication and Verfication AVS is a Fraud Prevention system the provided Billing Address to the Cardholder Address on file with the card issuer. AVS Code : The code returned by the AVS. AVS Response : This is a description of the AVS Code. Smart Routing This section will be displayed if Smart Routing was used to route the transation to the acquirer. Smart Routing Rule : The name of the rule that was used to route the transaction. Smart Routing Formula : The formula, based on the rule, that was evaluated to route the transaction. Metadata This section will be displayed if Metadata was present on the transaction. The data displayed will be the Metadata Key and the corresponding Value that was stored on the transaction. In the example above the Key is: meta1 and the Value is: value1 Transaction Details - Settlement The Settlement tab located within the Transaction Details page directs users to a section displaying settlement details data related to the transaction, if such information is available. Settlement Status section Transaction Reference ID: Unique transaction identifier. Status: Settlement Status value. Title Description INITIAL The settlement process has started, verifying each transaction to include in the settlement file. BUILT The settlement file is currently being built. SENT The settlement file is being sent to the upstream host. ERROR Status ERROR indicates that there was an error building/submitting the settlement file. EMPTY Indicates that there are no transactions to process as part of a settlement. MANUAL Status to indicate that the file was manually sent to the upstream host. ERROR_ACKNOWLEDGED This status is manually set by the Gateway Team. Used to indicate that investigation has taken place. RESPONSE_RECEIVED The upstream host has acklowedged that they have recieved the settlement file. CLOSED Once the support team have verified the response file/email from the host, support will mark the settlement has Closed (as below). Settlement Failure Reason: Reson for failure(if present) Last Status Change: Date of the last status change for the settlement. Merchant Id: Unique identifier for the merchant. Gateway Code: Acquirer gateway code as present in the acquirer configuration. Effective Date: Transaction effective date refers when the transaction was presented to the acquirer. Settlement Attempts section Settlement Attempt: Number of settlement attemps if there is a failure this value may me more than 1. Status Change Reason: Settlement status change reason if manually overwritten. Transaction Details - Refund Transaction Refund Transaction button on the Transaction Details page enables users to refund an unsettled transaction. If the transaction has not been voided, fully refunded, or settled, the Refund Transaction button will be visible to the user. Upon clicking this button, a slider will appear on the right side of the screen, allowing the user to specify the refund amount. Subsequently, the user can click on the Process Transaction button to execute the refund. Refund To initiate a refund for a transaction, perform the following steps: 1. Click the three dots next to the transaction. 2. Select Refund from the menu. 3 (a). If the Payment Channel is PayPal, a confirmation window pops up with the message: "Are you sure you want to refund this transaction of $XX.XX?" Select Yes to initiate the refund. 3 (b). For Payment Channel other than PayPal, such as Google Pay, Credit Card, etc. the Refund Transaction window slides in from the right. Fill in the necessary fields: Merchant: Automatically populated with the merchant's name. Transaction Type: Automatically set to Refund. Currency: Automatically set to the original currency type. Amount: Enter the amount to refund. The refund amount can only be equal to or less than the original transaction value. Stored Token: Automatically populated with the stored token. Client Transaction Reference: Enter the client transaction reference if applicable. Auth Code: Automatically populated with the authorization code. 4. Submit the refund request by clicking the Process Transaction button. Void You can void a transaction before it is settled (transactions in an open batch with the acquirer). To void a transaction, perform the following steps: 1. Click the three dots next to the transaction. 2. Select Void from the menu. 3. A confirmation window pops up with the message: "Are you sure you want to cancel this transaction of $XX.XX?" 4. To confirm and proceed with voiding the transaction, click Yes . 5. To cancel the void action, click No . Capture To capture the authorized amount for a transaction, perform the following steps: 1. Click the three dots next to the transaction you want to capture. 2. Select Capture from the menu. The Capture Transaction window slides in from the right. 3. Fill in the necessary fields: Merchant: Automatically populated with the merchant's name. Transaction Type: Automatically set to Capture. Currency: Automatically set to USD. Amount: Enter the amount to capture. Stored Token: Automatically populated with the stored token. Client Transaction Reference: Enter the client transaction reference if applicable. Auth Code: Automatically populated with the authorization code. 4. Submit the capture request by clicking the Process Transaction button. Generate Receipt The Generate eReceipt option allows users to generate a receipt for a selected transaction. Upon clicking this option, an eReceipt Options popup appears, where users can choose the preferred method such as Print or Email . Based on the selected option, the receipt is either printed or sent via email, providing a quick and convenient way to access transaction details.
  • [Perform Transactions](https://developer.pay.tnsi.com/merchant-portal-user-manual/transaction-management/perform-transactions.md): The Perform Transactions section enables you to initiate and process various types of transactions directly within the TNS merchant portal. Depending on whether you use a credit card or a stored token, the fields available for transaction entry will vary. This section simplifies executing transactions, ensuring you can efficiently handle all your transaction needs in a secure and user-friendly environment. Performing a Transaction with a Credit Card To perform a transaction using a credit card, perform the following steps: From the main menu bar navigate to Transactions . Click Perform Transactions under Transactions. Select the merchant for whom the transaction is being processed from the Merchant dropdown menu. Select the Card bullet to perform the transaction from a card. Select the type of transaction from the Transaction Type dropdown menu (e.g., Sale, Authorization, Refund). This dropdown is populated based on the user's permission. Choose the currency in which the transaction will be processed from the Currency dropdown menu. Only the currencies associated with the merchant are populated in the dropdown. Enter the transaction amount in the Amount field. Enter the credit card number in the Credit Card Number field without any spaces or dashes. Enter the card's expiry date in the Expiry field in MMYY format. Enter the card's CVV (Card Verification Value) code in the CVV field. Enter the name of the cardholder in the Cardholder Name field as it appears on the card. Enter a unique reference number for the transaction in the Client Transaction Reference field. After filling in all the required fields, click the Process Transaction button to process the transaction. 14. After the transaction is approved, all the transaction details are displayed. Performing a Transaction with a Stored Token To perform a transaction using a stored token, perform the following steps: From the main menu bar navigate to Transactions . Click Perform Transactions under Transactions. Select the merchant for whom the transaction is being processed from the Merchant dropdown menu. Select the Token bullet to perform the transaction from a stored token. Select the type of transaction from the Transaction Type dropdown menu (e.g., Sale, Authorization, Refund). This dropdown is populated based on the user's permission. Choose the currency in which the transaction will be processed from the Currency dropdown menu. Only the currencies associated with the merchant are populated in the dropdown. Enter the transaction amount in the Amount field. Enter the stored token for the transaction in the Stored Token field. Enter a unique reference number for the transaction in the Client Transaction Reference field. After filling in all the required fields, click the Process Transaction button to process the transaction. 11. After the transaction is approved, all the transaction details are displayed. 12. After the transaction is approved, all the transaction details are displayed. By filling in the required fields and selecting the appropriate options, you can efficiently perform transactions, ensuring accurate and secure processing.
• [Reporting](https://developer.pay.tnsi.com/merchant-portal-user-manual/reporting.md): The Reports section provides powerful tools to generate various reports that help you monitor and analyze your merchant account activities. This section allows you to create detailed reports on transactions, summaries, and blacklisted cards, offering valuable insights into your business performance. By accessing the Reports section, you can utilize filters and options to customize the data according to your specific needs, enabling effective tracking and decision-making. Types of Reports Transaction Reports : Generate detailed reports on all transactions processed through your account. Blacklist Reports : Generate reports on blacklisted cards, including details such as merchant name, date, and card number. Summary Reports : Create summary reports that provide an overview of your transactions over a specified period. Pay By Link Reports : Generate reports of Pay By Link transactions raised through your account for a specific period. Schedule Management : Display all the report delivery schedules. Allows user to edit, activate, or deactivate a report delivery schedule. Settlement Report : Generate detailed report on the settlement process. You can check the current status of the settlement file and other details. Each report type offers various filtering options to help you narrow down and focus on the data that is most relevant to your needs. By leveraging these reports, you can gain deeper insights into your transaction history, detect trends, and manage risk effectively.
  • [Transaction Reports](https://developer.pay.tnsi.com/merchant-portal-user-manual/reporting/transaction-reports.md): The Transaction Reports section allows you to generate detailed reports on all transactions processed through all or any specific merchant account. These reports provide comprehensive insights into your transaction history, helping you monitor activity, detect trends, and make informed business decisions. By utilizing various filters, you can customize the reports to focus on the data most relevant to your needs. Generating a Transaction Report To generate a transaction report, perform the following steps: Select the merchant for whom the transaction report is being generated from the Merchant dropdown menu. To include all merchants, select All . Enter the start date and time for the report in the Start Date and Time field (e.g., May 18, 2024, 17:14). Enter the end date and time for the report in the End Date and Time field (e.g., May 19, 2024, 17:14). Select the type of date to filter the report by from the Date Type dropdown menu (e.g., Date Effective, Date Authorized. Date Settled). Click on View More to access additional filters further discussed in the Advanced Filtering section. hat can further refine your report. Additional filters include options such as card type, transaction type, and more. After filling in all the required fields and selecting any additional filters, click the Run Search button to generate the transaction report. By following these steps, you can generate a detailed transaction report that provides valuable insights into your transaction history, enabling you to manage and analyze your business performance effectively. Advanced Filtering The advanced filtering options help you narrow down your search results, making it easier to find specific transactions and view comprehensive details. Selecting the View More button on the Seach Transaction page displays the advanced filters. The available filter options include: Card Number : Filter by the card number. First 6 : Filter by the first six digits of the card number. Last 4 : Filter by the last four digits of the card number. Card Type : Select the type of card used in the transaction, such as Visa, MasterCard, Amex, Diners, etc. (e.g., Visa, MasterCard). Card Entry Mode : Select the method used to enter the card details, such as E-commerce, EMV Contact, EMV Contactless, EMV Fallback, Magstripe, and Keyed. Status : Select the current status of the transaction, such as approved or declined. Transaction Type : Select the type of transaction, such as sale, authorization, and refund. Mode : Select the mode of the transaction. Receipt Number : Filter by the transaction's receipt number. Auth Code : Filter by the authorization code. Response Code : Filter by the response code received from the acquirer. Transaction Amount : Filter transactions based on the transaction amount. Configured Acquirers : Select the acquiring bank or processor configured in your account. RRN Number : Filter by the Retrieval Reference Number. TNS Terminal ID : Filter by the TNS Terminal ID associated with the transaction. TNS Reference Number : Filter by the TNS reference number associated with the transaction. By utilizing these advanced filtering options, you can quickly locate and analyze specific transactions, making the management of your transaction history more efficient and effective. Understanding the Transaction Report Results The generated transaction report provides a comprehensive overview of transactions within the specified period. The report includes detailed information on each transaction in a tabular format. The table can be filtered and sorted by various criteria as discussed in the Display Filters, Grid Search, and Pagination Guide to help you quickly find the information you need. For information related to automate transaction report delivery and exporting report data see Create Report Schedule and Export Report Data section. Here is a detailed explanation of the report columns and how to interpret the data: Merchant : The name of the merchant associated with the transaction. Authorized Date/Time : The date and time when the transaction was authorized. This is displayed in the format "Day Month Date Year Time GMT+Timezone (Timezone)". Card Number : The card number used in the transaction. For security reasons, only the first six and last four digits of the card number are displayed (e.g., 444433******1111). Card Type : The type of card used in the transaction, such as Visa, MasterCard, etc. Entry Mode : The method used to enter the card details, such as E-commerce, EMV Contact, EMV Contactless, Magstripe, Keyed, etc. Status : The current status of the transaction. Common statuses include Approved or Declined. Transaction Type : The type of transaction, such as Sale, Refund, Authorization, Reversal, etc. Mode : The mode of the transaction, which can indicate the environment or platform used (e.g., Online, Offline). Response Code : The response code received from the acquirer, indicating the result of the transaction. Common codes include 000 for approved transactions and specific numerical codes for declined transactions. Transaction Amount : The amount of money involved in the transaction. TNS Terminal ID : The Terminal ID associated with the transaction. Agreement ID : The Agreement Id of transactions. Payment Channel : The payment channel used for the transaction, such as PayPal, Credit Card, etc. Receipt Number : The unique receipt number assigned to the transaction. Displaying and Filter on Metadata If there are transactions in the report that have metadata stored against them, the Display Fields dropdown will present a Metadata option. Metadata, when stored against a transaction is stored as a Key/Value pair. The Key can have different values aligned to it. A transaction can have multiple Metadata Key/Value pairs but only one per key. When Metadata Display Fields option is ticked, new column(s) will be added to the report for each Metadata Key that is present in the set of transactions data determined by the filters. The Row will display the Metadata Value , if ithe metadata Key exists on the transactions. The Metadata does not have to appear on all transactions. In the image above, a new column, named meta1, has been added to the report. This is the key: meta1. The first row has a value for the Metadata Key - value1. Metadata columns can be filtered on as well, by clicking the filter button.
  • [Blacklist Reports](https://developer.pay.tnsi.com/merchant-portal-user-manual/reporting/blacklist-reports.md): The Blacklist Report section allows you to generate reports on transactions that have been blocked blacklisted cards, providing detailed information such as the merchant, date range, and specific card details. These reports help you monitor and manage blacklisted cards effectively, ensuring secure and compliant transaction processing. Generating a Blacklist Report To generate a blacklist report, perform the following steps: Select the merchant for whom the blacklist report is being generated from the Merchant dropdown menu. To include all merchants, select All . Enter the start date and time for the report in the Start Date and Time field (e.g., May 17, 2024, 17:22). Enter the end date and time for the report in the End Date and Time field (e.g., May 19, 2024, 17:22). Enter the card number: Enter the first six digits of the card number in the First 6 field. Filter by the last four digits of the card number in the Last 4 field. After filling in all the required fields and optional filters, click the Run Report button to generate the blacklist report. By following these steps, you can generate a detailed blacklist report that provides valuable insights into blacklisted cards, helping you manage and mitigate risks effectively. Understanding the Blacklist Report Results The generated blacklist report provides a comprehensive overview of blacklisted transactions within the specified period. The report includes detailed information on each transaction in a tabular format. The table can be filtered and sorted by various criteria as discussed in the Display Filters, Grid Search, and Pagination Guide to help you quickly find the information you need. Here is a detailed explanation of the report columns and how to interpret the data: Merchant : The name of the merchant associated with the transaction. Transaction Date/Time : The date and time when the transaction occurred. This is displayed in the format "Day Month Date Year Time GMT+Timezone (Timezone)". Card Number : The card number used in the transaction. For security reasons, only the first six and last four digits of the card number are displayed (e.g., 555555******4444). Expiry : The expiry date of the card in MMYY format. Transaction Type : The type of transaction, such as Sale, Authorization. Card Type : The type of card used in the transaction, such as Visa, MasterCard. Status : The current status of the transaction. Common statuses include Approved and Declined. Transaction Amount : The amount of money involved in the transaction. Mode : The mode of the transaction, such as e-commerce. Response Code : The response code received from the acquirer, indicating the result of the transaction.
  • [Summary Reports](https://developer.pay.tnsi.com/merchant-portal-user-manual/reporting/summary-reports.md): The Summary Report section allows you to generate summary reports that provide an overview of your transactions over a specified period. These reports help you analyze overall transaction trends and performance, making it easier to track and manage your business activities. Generating a Summary Report To generate a summary report, perform the following steps: Select the merchant for whom the summary report is being generated from the Merchant dropdown menu. To include all merchants, select All . Enter the start date for the report in the From Date field (e.g., May 1, 2024). Enter the end date for the report in the To Date field (e.g., May 19, 2024). Select the type of date to filter the report by from the Date Type drop-down menu (e.g., Date Effective, Date Authorized, and Date Settled). Select currency of the transactions. Select the mode of transactions to include in the report from the Mode dropdown menu (e.g., Online, Offline, and Offline - Deferred Authorization). To include all modes, select All . After filling in all the required fields and selecting any optional filters, click the Run Report button to generate the summary report. 8. The search result in displayed in the tabular format. By following these steps, you can generate a detailed summary report that provides valuable insights into your transaction trends and performance, helping you manage and analyze your business activities effectively. Understanding the Summary Report Results The generated summary report provides a comprehensive overview of transactions within the specified period. The report is typically divided into sections based on various criteria, such as card type, transaction type, and status. Here is a detailed explanation of the report columns and how to interpret the data: Card Type : The type of card used in the transactions (e.g., VISA, MasterCard, AMEX). Count : The total number of transactions for each type. Sale/Refunds/Authorization/Capture/Reversals : These columns provide the breakdown of transaction types, indicating the count and amounts for each category. Detailed Columns for Each Transaction Type For each transaction type (Sale, Refund, Authorization, Capture, Reversals), the report includes Approved and Declined sections, with separate counts and amounts for each: Approved : Count: The number of approved transactions. Amount: The total amount of money for approved transactions. Surcharge: Any additional charges for approved transactions. Declined : Count: The number of declined transactions. Amount: The total amount of money for declined transactions. Surcharge: Any additional charges for declined transactions. When the user clicks on a card type name (e.g., AMEX) in the report, the system navigates to the Transactions screen and displays a detailed list of transactions associated with the selected card type. The transactions are shown in a tabular format, including key details such as Merchant Name, Entry Mode, Response Code, Terminal ID, Payment Channel, Receipt Number, Transaction Reference, Amount, and Date/Time. This allows users to view and analyze all individual transactions related to the selected category. Account Verification counts has been added to the Summary Report. The Account Verification count fields added to the Summary Report show the number of Account Verification transactions that occurred within the selected reporting period, broken down by approved and declined outcomes — consistent with how other transaction types (Sales, Refunds, Authorisations, etc.) are displayed in the report. Grand Total The Grand Total option provides a consolidated summary of all transaction data displayed in the report. When enabled (checked), a Grand Total row appears at the bottom of the table, aggregating values across all merchants and card types. This row includes totals for key metrics such as: Total transaction count Approved and declined counts Total sales and refund amounts Surcharges and other financial values The Grand Total helps users quickly view overall performance without needing to manually sum individual rows. If the option is unchecked, the Grand Total row is hidden from the report. Surcharge The Surcharge option allows the user to select if they want to display the surcharges columns on the report. Ticking the Surcharge option will display the surcharge columns. Un-clicking the option will remove the surcharges from the dsplay. If there are no surcharges on the report, the option will not be available.
  • [Schedule Management](https://developer.pay.tnsi.com/merchant-portal-user-manual/reporting/schedule-management.md): All the scheduled rerports are listed under Schedule Management. User can view, edit or deactivate the schedule report from this screen. To edit a report schedule Click three dots next to a record. Select Edit from the menu 3. Update the required fields. For details on every field see Creating Report Schedule and Export Report Data section. 4. Once all the required fields are updated click on Save button to save the changes. To deactivate a schedule report Click on the three dots next to a record Select Deactivate from the menu Filter Options Display Fields lets you control which columns appear in the table. You can show or hide specific fields to focus only on the information that matters most to you. This helps keep the view clean and relevant. Filter allows you to refine the data shown by applying conditions such as status, frequency, or date. It helps you quickly find specific records without going through the entire columns. Save View enables you to store your customized setup, including selected fields and applied filters. This makes it easy to return to the same view later without reconfiguring it.
  • [Settlement Report](https://developer.pay.tnsi.com/merchant-portal-user-manual/reporting/settlement-report.md): Settlement Report provides detailed insights into settlement data, including total transaction count, total transaction amount, and a breakdown of transactions. Merchant: Select the merchant for whom the settlement report is being generated from the Merchant dropdown menu. To include all merchants, select All . From Date : Enter the start date for the report in the Start Date field (e.g., May 18, 2024). To Date Enter the end date for the report in the End Date field (e.g., May 19, 2024). Acquirer: If you want to specify an acquirer as a report filter select it from the Acquirer dropdown menu. Currency: Choose the currency from the Currency dropdown menu. After filling in all the required fields, click the Run Report button to generate the report. 7. The search result is displayed in the tabular format. Understanding the Settlement Report Results Date : Transaction date in UTC format. Acquirer : Name of the acquirer. Total Settlement Amount: Total settlement amount for the selected period. Total Transaction Count: Total number of transactions for the selected period. Sale: There are two sub-sections under sale: Amount and Count . These sections represent the total amount of sale transactions and the total number of sale transactions, respectively. Capture: There are two sub-sections under capture: Amount and Count . These sections represent the total amount of capture transactions and the total number of capture transactions, respectively. Refund: There are two sub-sections under refund: Amount and Count . These sections represent the total amount of refund transactions and the total number of refund transactions, respectively.
  • [Creating Report Schedule and Export Report Data](https://developer.pay.tnsi.com/merchant-portal-user-manual/reporting/creating-report-schedule-and-export-report-data.md): A Schedule button is available on every report page to automate the report delivery according to user selection. Upon clicking the Schedule button, a slider will appear on the right side of the screen. This slider allows you to choose the report generation period, report delivery frequency, and delivery method. Schedule Report Name: You can provide a unique schedule report name to identify the report schedule. Report Period : You have the option to choose from the predefined report range to generate and deliver the report to your mailbox (e.g. Last Day, Last 7 Days, Last 30 Days, Last 6 months & Last Year). Frequency: You can choose the delivery frequency here. Available options are Daily, Weekly, Monthly & Yearly. When choosing the frequency as Daily , users should choose an option All Days (all 7 days in a week) or Weekdays (Monday to Friday). When choosing the frequency as Weekly , user must input the interval option in the Every field. 1 would stand every week and 2 will stand every week and so on. Also user need to select a day when they are expecting the report to deliver. When user choosing Monthly delivery option, user must inut Day as day of monthe the report is expected, of every interval of months, i.e. 1 will send the report every monthe 2 will send the report every alternate month and so on. Also user need to select a time from the at dropdown when the report delivery is expected. When user selecting frequency as Yearly user need to input the interval in the every field. Select month of the year and the date when the report is expected to deliver. 4. Report Filename Format: User can select report format from the available options under this section. Currently the system supports only csv file format. 5. Send Via Email: User can select the delivery metheod from the av available options. Currently sending the report via email only available. 6. Recipient Email: Provide the email id where the report will be delivered. Add multiple email IDs separated by commas for more than one recipient. 7. After filling in all the required fields and selecting any optional fields click Save button to save the report delivery schedule. Export Report Data Exporting report data to CSV file format is a feature available in all reports. Users can initiate the process by clicking on the export button, which will automatically download the entirety of the selected data based on the applied filter criteria.The file downloaded is named according to the date and time of the download, taking into account the user's timezone. Display fields The Display Fields option allows users to customize the columns displayed in the transaction table. On clicking Display Fields , a list of available fields appears with checkboxes. Users can select or deselect fields such as Merchant Name, Transaction Amount, Card Type, and more based on their requirement. The table updates instantly to display only the selected fields, helping users focus on relevant information and improve data visibility. The Column Filter option allows users to search and filter data within each column of the transaction table. A search input box is provided below every column header, where users can enter specific values (e.g., Merchant Name, Response Code, Transaction ID, etc.). The table updates instantly to display only the matching records, making it easier to find specific information quickly. Save View (User Preference) The Save View option allows users to save their current table preferences for future use. This includes selected display fields, applied column filters, and table settings. Once saved, these preferences are stored for the specific user and database table, ensuring that the same customized view is automatically applied whenever the user revisits the page.
  • [Notification report](https://developer.pay.tnsi.com/merchant-portal-user-manual/reporting/notification-report.md): The Notification Report section allows you to manage and track the delivery status of automated system alerts. This report is used to verify that notifications (such as transaction updates) are being sent correctly to your designated endpoints or email addresses. Generating a Notification Report To generate a notification report, perform the following steps: Enter the Start Date and Time for the search (e.g., December 1, 2025). Enter the End Date and Time for the search (e.g., March 19, 2026). Select a specific status from the Status dropdown menu (e.g., UNREAD or READ ) to filter results. Click the Run Report button to view the notification data. Create Notification Click this button to set up a new notification trigger for specific transaction events. To create a notification, perform the following steps: Click the Create Notification button available in the Notification Report section. In the Create Notification form, provide the required details: Customer: Select the customer from the Customer dropdown menu for whom the notification is being created. User: Select the specific user who will receive the notification. Subject: Enter the subject or title of the notification. Message: Enter the notification message or content that you want to send to the user. After entering all the required information, submit the form to send the notification to the selected user. The notification will then be delivered to the user through the system notification mechanism.
  • [AI Assistant Reports](https://developer.pay.tnsi.com/merchant-portal-user-manual/reporting/ai-assistant-reports.md): The AI Assistant Report provides a comprehensive log of all interactions with the platform's AI Assistant. This report is used to monitor AI utilization, audit user queries, and analyze the performance and accuracy of AI-generated responses within the portal. Generating an AI Assistant Report To generate an AI Assistant report, perform the following steps: Enter the Start Date and Time and End Date and Time . (Optional) Enter a specific User email to audit a particular team member's queries. (Optional) Enter a keyword in the Prompt field to search for specific topics discussed with the AI. Click the Run Report button to view the execution history. Understanding the Report Fields Execution: A clickable link that opens a detailed view of the specific AI response. Prompt: The original question or command entered by the user. Input/Output Tokens: The technical volume of data processed for the query and response. Start/End Time: The exact duration the AI took to process the request. Processing Time (s): The total time in seconds the system took to generate the result. Viewing Execution Details Clicking the Execution link in any row will open a pop-up window containing the full details of that interaction: Execution Result: Displays the complete text response generated by the AI, including step-by-step guides or data analysis. Feedback Type: Shows if the user provided a positive or negative rating on the response. Metadata: Displays the Execution Name (e.g., FINALRESPONSE) and the precise timestamp. Managing the Results Use the standard table tools to customize your view: Display Fields: Show or hide specific notification metrics. Export: Download your notification logs for external troubleshooting. Save View: Save your preferred filter settings for recurring audits. Filter (Icon): Search for specific events or status codes directly in the grid.
• [Token Service](https://developer.pay.tnsi.com/merchant-portal-user-manual/token-service.md): The Token Service section allows you to search, view, add, edit, and delete tokens for credit card numbers, providing an added layer of security for your transactions. Tokens help securely process payments without exposing sensitive card details. This section enables you to view existing tokens and add new tokens as needed. View and Search Tokens The View and Search Tokens feature allows you to search for specific tokens using various criteria such as token number, credit card number, expiry date, and cardholder name. This feature helps you quickly find and manage tokens within the portal. Add Tokens The Add Tokens feature provides the functionality to generate new tokens for secure transaction processing. By replacing sensitive credit card information with unique tokens, this feature enhances security and reduces the risk of data breaches. Edit Tokens The Edit Tokens feature allows you to update the details of existing tokens. This feature ensures that you can maintain accurate and up-to-date information for all tokens in your system. Delete Tokens The Delete Tokens feature enables you to remove tokens that are no longer needed or are associated with expired or inactive credit cards. This feature helps you manage and clean up your token database, maintaining its relevance and security.
  • [View and Search Tokens](https://developer.pay.tnsi.com/merchant-portal-user-manual/token-service/view-and-search-tokens.md): The View and Search Tokens feature allows merchants to search for specific tokens using various criteria such as token number, credit card number, expiry date, and cardholder name. This feature helps you quickly find and manage tokens within the portal. To view and search for tokens, perform the following steps: Click Token Service from the main menu. Select the merchant for whom you want to view tokens from the Merchant dropdown menu. (Optional) Enter the token number in the Token field to search for a specific token. (Optional) Enter the last four digits of the credit card number in the Credit Card field to search for specific tokens. (Optional) Enter the card's expiry date in MMYY format in the Expiry field to search for tokens expiring in a specific month and year. (Optional) Enter the cardholder's name in the Cardholder Name field to search for tokens associated with a specific cardholder. Click the Run Search button to display the tokens that match the search criteria. Displaying Search Results After running the search, the results are displayed in a tabular format. The table can be filtered and sorted by various criteria as discussed in the Display Filters, Grid Search, and Pagination Guide to help you quickly find the information you need. The results consist of the following columns: Token : The generated token number. Credit Card : The masked credit card number (e.g., ************0129). Expiry : The expiry date of the card in MMYY format. Cardholder Name : The name of the cardholder. The Token Service section allows you to generate and manage tokens for card numbers, providing an added layer of security for your transactions.
  • [Add Tokens](https://developer.pay.tnsi.com/merchant-portal-user-manual/token-service/add-tokens.md): The Add Token feature allows merchants to generate tokens for secure and efficient transaction processing. Tokens replace sensitive credit card information with a unique identifier, enhancing security and reducing the risk of data breaches. This guide will walk you through the steps required to add a new token to the merchant portal. To add a new token, perform the following steps: 1. Click Token Service from the main menu. 2. Click on the Add Token button. The Add Token window slides in from the right side of the screen. 3. Merchant Detail Select the merchant for whom the token is being generated from the Merchant dropdown menu. 4. Card Holder Information Enter the credit card number in the Credit Card field without any spaces or dashes. Enter the card's expiry date in MMYY format in the Expiry field. Enter the name of the cardholder in the Cardholder Name field as it appears on the card. 5. After filling in all the required fields, click the Save button to generate the token. 6. The token has been successfully added for credit card ************4444 message is displayed along with the token. By following these steps, you can efficiently generate and manage tokens, ensuring secure and compliant transaction processing.
  • [Edit Tokens](https://developer.pay.tnsi.com/merchant-portal-user-manual/token-service/edit-tokens.md): The Edit Token feature allows merchants to edit tokens for secure and efficient transaction processing. This guide will walk you through the steps required to edit an existing token in the merchant portal. To edit an existing token, perform the following steps: Click Token Service from the main menu. Fill in the search fields: Select the merchant for whom you want to view tokens from the Merchant dropdown menu. (Optional) Enter the token number in the Token field to search for a specific token. (Optional) Enter the last four digits of the credit card number in the Credit Card field to search for specific tokens. (Optional) Enter the card's expiry date in MMYY format in the Expiry field to search for tokens expiring in a specific month and year. (Optional) Enter the cardholder's name in the Cardholder Name field to search for tokens associated with a specific cardholder. Click the Run Search button to display the tokens that match the search criteria. The search result is displayed based on the search criteria in a tabular format. Click the three dots icon corresponding to the token you want to edit. Click Edit . 6. The existing details of the token are displayed under Current Details. 7. Update Credit Card: Enter the updated credit card number in the Update Credit Card field. Enter the updated credit card expiry in the Expiry field. Enter the updated credit card holder name in the Cardholder Name field. 8. Click Update to update the token. Delete Tokens The Delete Token feature allows merchants to delete tokens for secure and efficient transaction processing. This guide will walk you through the steps required to delete an existing token in the merchant portal.
  • [Delete Tokens](https://developer.pay.tnsi.com/merchant-portal-user-manual/token-service/delete-tokens.md): The Delete Token feature allows merchants to edit tokens for secure and efficient transaction processing. This guide will walk you through the steps required to delete an existing token in the merchant portal. To delete an existing token, perform the following steps: Click Token Service from the main menu. Fill in the search fields: Select the merchant for whom you want to view tokens from the Merchant dropdown menu. (Optional) Enter the token number in the Token field to search for a specific token. (Optional) Enter the last four digits of the credit card number in the Credit Card field to search for specific tokens. (Optional) Enter the card's expiry date in MMYY format in the Expiry field to search for tokens expiring in a specific month and year. (Optional) Enter the cardholder's name in the Cardholder Name field to search for tokens associated with a specific cardholder. Click the Run Search button to display the tokens that match the search criteria. The search result is displayed based on the search criteria in a tabular format. Click the three dots icon corresponding to the token you want to delete. Click Delete . 7. A pop-up window is displayed with the confirmation message. Select Delete to delete the token.
• [Recurring Payments](https://developer.pay.tnsi.com/merchant-portal-user-manual/recurring-payments.md): The Recurring Payments section provides tools to search, add, and manage recurring transactions within the merchant portal. This feature allows merchants to automate regular payments, such as subscription fees or installment plans, ensuring timely and consistent billing. Search Recurring Payments The Search Recurring Payments feature allows you to find existing recurring payment plans based on various criteria. This is essential for monitoring and managing recurring payment schedules. Add Recurring Payments The Add Recurring Payments feature enables you to create and schedule new recurring transactions.
  • [Search Recurring Payments](https://developer.pay.tnsi.com/merchant-portal-user-manual/recurring-payments/search-recurring-payments.md): The Search Recurring Payments feature allows you to find existing recurring payment plans based on various search criteria. This is essential for monitoring and managing recurring payment schedules. To search for a recurring payment, perform the following steps: From the main menu bar, click Recurring Payments . Enter the search criteria: Select the merchant for whom the recurring payments are being searched from the Merchant dropdown menu. (Optional) Enter the start date in the Start Date field to filter the recurring payments starting from this date. (Optional) Enter the end date in the End Date field to filter the recurring payments up to this date. Select the type of date to filter by from the Date Type dropdown (e.g., Contract, Expiring Payments). Select the payment frequency (e.g., Daily, Weekly, Monthly, Yeary) from the Frequency dropdown menu. Select the status of the contract from the Contract Status dropdown (e.g., All, Active, On Hold, Ended). (Optional) Enter the agreement ID in the Agreement ID field to search for a specific recurring payment agreement. Enter the Transaction Amount for the recurring payments.(e.g., 10.00) Select the payment method for the recurring payments (e.g., Credit, Token) from the Payment Method dropdown menu. Click the Run Search button to display the results. Search Results After performing a search, the results are displayed in a tabular format. Each row represents a recurring payment plan, and the columns provide specific details about each plan. The columns in the search results include: Merchant: The name of the merchant associated with the recurring payment. Start Date: The start date of the recurring payment. End Date: The end date of the recurring payment. Card Number: The masked card number used for the recurring payment. Expiry: The expiry date of the card used for the recurring payment. Card Holder Name: The name of the cardholder (if available). Transaction Amount: The amount of the transaction. Transaction Reference: The reference ID for the transaction. Transaction Status: The status of the transaction (e.g., SUCCESS, FAIL). Last Run Date: The date when the last payment was processed. Frequency: The frequency of the payments (e.g., Daily, Weekly, Monthly). Status: The current status of the recurring payment plan (e.g., Active, Inactive). Utilizing Search Results By analyzing the search results, you can monitor and review recurring payment history effectively. Sorting and filtering options help you narrow down the results to find specific transactions quickly. For example, you can sort the results by Start Date/End Date to see the most recent transactions first, or filter by Status to view only approved or declined transactions. Understanding the detailed information provided in each column allows you to: Verify recurring payment details and status. Identify patterns or anomalies in transaction data. Ensure accurate record-keeping and reporting. By leveraging these search and filtering capabilities, you can efficiently manage your recurring payment history within the merchant portal.
  • [Add Recurring Payments](https://developer.pay.tnsi.com/merchant-portal-user-manual/recurring-payments/add-recurring-payments.md): The Add Recurring Payments feature enables you to create and schedule new recurring transactions. Follow these steps to set up a new recurring payment plan: To add a new recurring payment, perform the following steps: From the main menu bar, click Recurring Payments . To add a new recurring payment, click the Add New Recurring Payment button. 3. Enter Contract Details: Select the merchant for whom the recurring payments are being searched from the Merchant dropdown menu. Enter the start date in the Start Date field for the recurring payment plan. This is the date when the first payment will be processed. Enter the end date in the End Date field for the payment plan if applicable. If the plan is indefinite, leave this field empty. 4. Select the payment frequency (e.g., Daily, Weekly, Monthly) from the Frequency dropdown menu. a. Daily frequency has 2 options to select for All Days or Weekdays b. Weekly frequency provides options for day of the week (Sunday to Saturday) c. Monthly frequency provides option for interval and date of the month d. Yearly frequency provides option to select interval ,Month and date of the month. 5. Select the payment method for the recurring payment from the Payment Method dropdown menu. a. Credit Card : Provides option to create recurring payment with credit card number ,expiry date ,currency , card holder name , client transaction reference and transaction amount. b. Token: Provides option to create recurring payment for credit card token ,currency ,client transaction reference and transaction amount. 6. Click Create to create the recurring payment plan. Utilizing Recurring Payments By setting up and managing recurring payments, you can automate billing processes, reduce manual intervention, and ensure consistent revenue streams. The detailed management options allow you to adjust payment plans as needed, providing flexibility and control over your automated billing.
• [Maintenance](https://developer.pay.tnsi.com/merchant-portal-user-manual/maintenance.md): The Maintenance section provides essential tools for managing the security and integrity of your merchant account. This section includes features for managing credit card blacklists and encryption keys, ensuring that your transactions are secure and compliant with industry standards. The two main features in this section are Credit Card Blacklist and Key Management . Credit Card Blacklist The Credit Card Blacklist feature allows you to add and manage blacklisted credit cards to prevent fraudulent transactions. By maintaining a blacklist, you can ensure that certain card numbers are blocked from being used in your transactions, enhancing the security of your payment processes. Key Management The Key Management feature provides a centralized place to manage encryption keys used for secure transactions. Proper management of these keys is crucial for maintaining the confidentiality and integrity of your transaction data. This feature allows you to add, edit, and manage keys effectively to ensure your data remains protected.
  • [Credit Card Blacklist](https://developer.pay.tnsi.com/merchant-portal-user-manual/maintenance/credit-card-blacklist.md): The Credit Card Blacklist feature allows you to manage and view blacklisted credit cards under each merchant account. This tool is essential for preventing fraudulent transactions and ensuring compliance with security standards. You can add cards to the blacklist to block them from being used in transactions. Viewing and Managing Blacklisted Cards To view and manage blacklisted cards, perform the following steps: Select the merchant for whom you want to view the blacklisted cards from the Merchant dropdown menu. To include all merchants, select All . Click the Run Search button to display the blacklisted cards for the selected merchant. Search Results When you run a search for all blacklisted cards, the results are displayed in a tabular format. The table can be filtered and sorted by various criteria as discussed in the Display Filters, Grid Search, and Pagination Guide to help you quickly find the information you need. The results consist of the following columns: Merchant : The name of the merchant associated with the blacklisted card. Credit Card : The masked credit card number (e.g., 385200********37). Expiry : The expiry date of the card (if available). Listed Since : The date when the card was added to the blacklist. Status : The current status of the card (e.g., Blacklisted). Adding a Card to the Blacklist To add a card to the blacklist, follow these steps: Click on the Add to Blacklist button. A window slides in from the right side of the screen with the following options: Select the merchant for whom the card is being blacklisted from the Merchant drop-down menu. Select the type of Primary Account Number (PAN) from the PAN Type options: Full PAN Masked PAN If Full PAN is selected: Enter the full card number in the PAN field. If Masked PAN is selected: Enter the first six digits of the card number. Enter the last four digits of the card number. Enter the card's expiry date in the Expiry field in MMYY format. After filling in all the required fields, click the Save button to add the card to the blacklist. Deleting a Card from the Blacklist To delete a card from the blacklist, follow these steps: Select Credit Card Blacklist under Maintenance from the main menu. Select the merchant from the Merchant drop-down menu. Click Run Search . The list of blacklisted cards associated with the selected merchant is displayed in a tabular format. Click the delete icon corresponding to the credit card that needs to be removed from the blacklist. A window pops up with the message “Are you sure you want to delete this from the blacklist?” Click Delete to remove the card from the blacklist. By following these steps, you can efficiently manage, add, and delete blacklisted cards.
  • [Key Management](https://developer.pay.tnsi.com/merchant-portal-user-manual/maintenance/key-management.md): The Key Management feature provides a centralized place to manage encryption keys and API keys used for secure transactions. Proper key management is crucial for maintaining the confidentiality and integrity of your transaction data. This section allows you to view, search, and manage keys effectively. Viewing and Managing Keys To view and manage keys, perform the following steps: Select Key Management under Maintenance in the main menu. Select the level for which you want to view the keys from the Level dropdown menu. To include all levels, select All . Select the merchant for whom you want to view the keys from the Merchant dropdown menu. To include all merchants, select All . Enter the start date for the search in the From Date field (e.g., May 1, 2024). Enter the end date for the search in the To Date field (e.g., May 19, 2024). (Optional) Enter the API key to search for a specific key. Click the Run Search button to display the keys that match the search criteria. Search Results When you run a search for keys, the search results display the keys that match your search criteria in a tabular format. The table can be filtered and sorted by various criteria as discussed in the Display Filters, Grid Search, and Pagination Guide to help you quickly find the information you need. Each row in the table represents an API key and includes the following columns: API Key : The identifier for the API key, partially masked for security (e.g., 03bd******12e1). Merchant : The name of the merchant associated with the API key. Created Date : The date when the API key was created. Last Used Date : The date when the API key was last used. Service : The services associated with the API key (e.g., Payments, Tokenization, Hosted Checkout, HSM). Status : The current status of the API key (e.g., Active, Inactive).
• [Glossary](https://developer.pay.tnsi.com/merchant-portal-user-manual/glossary.md): This section will capture commonly used terminology and provide meaning/context. Term Account Verification Transactions A Type of Transaction that can be performed that verifies a cardholder's account with the issuing bank without actually charging any money. AID Application Identifier A property of a card that can be used to identify the Issuer and whether the type of card, whether it be a Debit or Credit card. Customer Company In Payment Orchestration, the Customer sits at the top of the Customer Hierarchy of levels and merchants. The Customer represents, the company that owns/controls all the Merchant. Final Node Smart Routing. A Final Node is used to end a Smart Routing Path. There are no outward points from a FInal Node. The most common example is an Acquirer node - at the end of the path the acquirer the Merchant wants to process the transactions, which have satisfied the nodes on the path, is set. Level Within the Customer Hierarchy, the Level represents a logical grouping of Merchants that appear underneath it. Payment Orchestration Customer can use a level to group their merchants together, how they like. Geographic or Division based groupings are common examples. Generally, some of the properties on the Level can be inherited or made available to the merchants that sit underneath it. A level can also have sublevels. Merchant The Merchant is the entity aginst which transactions are recorded and processed. These can represent physical branches, agencies, shops, etc. A merchant is the “Merchant of Record”. Within the Customer Hierarchy, Merchant's sit at the end of the branches.