Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
merchant:existing_merchant:selfcare_system:reporting [2020/06/02 17:38]
robinc [Open Batch]
merchant:existing_merchant:selfcare_system:reporting [2021/05/21 17:49]
robinc [Customize your Scheduled Report] updated Report columns
Line 100: Line 100:
 ===== Closed Batch =====  ​ ===== Closed Batch =====  ​
  
-The **Closed Batch** report provides Merchants with the ability to+{{:merchant:​existing_merchant:​selfcare_system:​reporting:​closedbatch1.png|}}
  
-  * **I)** View closed batches by day, on terminal or all the merchant'​s terminals. +After performing ​a transaction, ​the transaction ​will appear in Open BatchAfter settlement, ​the transaction is moved to Closed Batch and grouped by settlement date.
-  * **II)** View transactions on a closed batch with general details. +
-  * **III)** Export transactions on a closed batch to a CSV file. +
-  * **IV)** View net totals. +
-  * **V)** Search transactions in closed batches - by transaction ​infocard details, custom fields or other options. +
-  * **VI)** View transaction ​details. +
-  * **VII)** Resend ​the cardholder receipt copies. +
-  * **VIII)** Refund older transactions which have already been settled. +
-  * **IX)** Print merchant or cardholder receipts copies.+
  
-You can access the **Closed Batch** ​by clicking on the "**Reporting**" tab:+**Closed Batch** ​is located with the **Reporting** ​section on Selfcare. Below are the functions available in Closed Batch.
  
-<​html><​img ​ class="​imageReplace img_small"​ src= " +  *   • View closed batches by date, on a terminal or all the merchant'​s terminals that the user as access. 
-data/media/merchant/​existing_merchant/​selfcare_system/​reporting_closed_batch-nu.png"/></​html>​+  *   • View and perform operations (subscriptions,​ refunds, etc.) for transactions within a closed batch. 
 +  ​* ​  • Export all transactions for a closed batch to a CSV file. 
 +  *   • View total volume and amount of transactions within a batch and in different periods (day, week, month). 
 +  *   • Search transactions in multiple closed batches and in different terminals. 
 +  *   • View transaction details. 
 +  *   • Refund settled transaction. 
 +  *   • Resend cardholder receipts. 
 +  *   • Print merchant ​or cardholder receipts.
  
-\\ +After opening ​**Closed Batch**, there are 2 tabs at the top: **Batches** and **Transactions**. We cover these separately below.
-You can search for **settled (i.e. closed) transactions** in the "**Find a Transaction**" tab by: Order ID (it's a unique transaction number given by the merchant; i.e. order reference number), unique reference (it's a unique transaction number attributed automatically to each transaction by Nuvei system) or by amount range (the range of the transaction value).+
  
-<​html><​img ​ class="​imageReplace img_small"​ src= " 
-data/​media/​merchant/​existing_merchant/​selfcare_system/​reporting_closed_batch2-nu.png"/></​html>​ 
  
-\\ +====Batches Tab==== 
-You can also click on the "​**Advanced Filter**"​ tab, where you will be able to broaden the search criteria byTransaction Date, Operator, Card Types and Transaction Result (e.g approval, referral, decline, void)+{{:merchant:​existing_merchant:​selfcare_system:​closedbatchtab.png|}}
  
-<​html><​img ​ class="​imageReplace img_small"​ src= " +The top of the Batches section will allow you to perform searches to retrieve a particular batch. You can search for a batch on a single terminal or multiple terminals. Search for a specific date or a date range. If your search has any matches, a table will deploy all the results available.
-data/​media/​merchant/​existing_merchant/​selfcare_system/​reporting_closed_batch3_advanced-nu.png"/></​html>​+
  
-\\ +In the graph section, ​the top menu will provide a summary ​of the settled transactions for different periods: 
-In closed batch you will be able to view all settlements for the terminal. The transactions are grouped by settlement date/time and the batch will show number and value of: sales per batch, refunds, voids as well as total deposits.+  *   • Last Batch: Provides details of the latest settled ​batch
 +  *   • This Week: Provides details about batches settled within the current week. 
 +  *   • This Month: Provides details about batched settled in the current month.
  
-To view the Batch transaction details simply click on the date of the settlement you wish to view. The batch transaction details include ​the transactions Time and Date, Order ID, Operator (this is the name of the person who processed the credit card detailsIt can also be an automatic payment), type of transaction,​ status, name of cardholder, securely masked card number, amount, and card type +Each of these different menus will display graphs according ​to the period selected. 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtab2.png|}}
  
-Below the transactions ​in the batch you will also see Net Total which will be the sum of all complete ​transactions on the current page.+The first graph for single currency terminals is Net Total, with the total amount settled ​in the time frame selected. For multicurrency terminals, the Net Total is displayed in a bar chart indicating ​the volume ​of transactions ​separated by currency; ​on mouse-over an information bubble will show the total amount for each currency.
  
-<​html><​img ​ class="​imageReplace img_small"​ src= " +The second graph is a pie chart with information about the transactions’ status within the timeframe selected.
-data/​media/​merchant/​existing_merchant/​selfcare_system/​reporting/​nuvei_closed_batch_transaction.png"/></​html>​+
  
-\\ +The third graph will indicate ​the transaction ​volume per hour, weekday, or day depending on the time frame selected. This data can be used for tracking ​the impact of marketing effortssales events, email campaigns, etc.
-Click on the transaction ​date/time field to see the individual transaction detailsas per the screenshots below:+
  
-<​html><​img ​ class="​imageReplace img_small"​ src= " +The next section contains a list with a breakdown of transactions per currency with Charged Amount, Charged Transactions,​ Refunded Amount, Refunded Transactions,​ and Net Total details. Clicking on the arrow to the left will break down the transactions for each currency per card brand (only card brands with transactions will display here).
-data/​media/​merchant/​existing_merchant/​selfcare_system/​transaction_detailspiv-nu.png"/></​html>​+
  
-\\ +{{:merchant:​existing_merchant:​selfcare_system:​closedbatchtab3.png|}}
-The option to print the **Merchant Receipt** or the **Cardholder Receipt** is available. You can also resend the receipt to the merchant ​from here.+
  
-It is possible to **refund** this transaction at this stageif neededClick on the "​Refund"​ button ​in the bottom ​right corner.+Below the currency breakdownwe find the Batch List of the period range selected (Last Batch, This Week, This Month)This is a list of all batches included in that period range. Clicking ​on the date will show all transactions included ​in that particular batch. On the right side, an action menu will appear when the user clicks on the dots [∙∙∙] menuThree different actions will be presented:
  
-A completed sale transaction can be refunded only by the operator who is granted permission to perform refunds. Refund controls are not displayed if the logged-on user does not have required permissions.+{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtab4.png|}}
  
-A refund reason should be provided for each refund and refunded amount can be modified, however ​the refund amount ​can’t exceed original sale transaction amount. When the refund reason is entered and the amount checked/modified, clicking on the "​Refund"​ button will create a new refund transaction,​ and this transaction will appear ​in the terminal Open Transactions listRefunds can be cancelled at any time up until the Settlement time by marking the transaction ​as "​Void"​. The refund confirmation screen will appear if the operation was successful. New refund ​transactions ​will be settled during the nearest settlement process if it is marked as "​Ready"​.+  *   • View Batch Transactions:​ Displays all transactions within ​the batch. The user can use this or click on the date/time link in the table. 
 +  *   • View Batch Summary: Displays a summary of the batch with a detailed graph and breakdown of transactions divided ​by currency. 
 +  *   • Expert ​as CSV: Will export all transactions ​to a CSV file format.
  
 +The first 2 items will be explored in the Batch Transactions and Batch Summary sections below.
  
-===== Scheduled Report ​=====  ​+====Transactions Tab==== 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactions.png|}}
  
-The **Scheduled Report** feature allows merchants to create their own reports, choosing the criteria used to generate the report, the data present as the result, ​and the periodicity and way in which the report should be delivered.+For the Transactions section, you can locate a transaction using multiple criteria: 
 +  ​  • Terminal ID 
 +  ​  • Order ID 
 +  ​  • Unique Ref 
 +  ​  • Card Number (first 6 and last 4 digits) 
 +  *   • Transaction Date 
 +  *   • Cardholder Name 
 +  *   • Amount 
 +  *   • Retrieval Number
  
-**List ​of Reports**+Additional search criteria can be added as needed. If the search criteria results in a large amount ​of data, you will need to narrow your search or utilize Scheduled ​Reports ​to retrieve the data. A notification is displayed if you hit the limit on the amount of data that can be retrieved when using the search feature in Closed Batch.
  
-Merchant can define ​as many reports as they desire, with different configurations, for different needs.+Schedule Reports can be found under the Reporting Menu in Selfcare. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactions2.png|}} 
 + 
 +If any transaction matches the query, the system will display them in the table. Clicking on the left arrow will open additional information about the transaction. The line to the left of the transaction will change colors based on the status of that transaction. Green means the transaction was COMPLETE, yellow means PENDING, red means DECLINED, and gray for any other response. Clicking on Order ID will display the transaction details panel. 
 + 
 +You can quickly perform actions on the transactions listed by clicks on the dots [∙∙∙] menu. 
 + 
 +  *   • View the transaction details 
 +  *   • Refund the transaction 
 +  *   • View Sentinel Defend Events (if enabled for your terminal) 
 +  *   • Resend the cardholder receipt 
 +  *   • Print receipt 
 +  *   • Create a Secure Card or Subscription 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactions3.png|}} 
 + 
 +  *   • **Transaction Details** to view additional information about a transaction 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactions4.png?​400}} 
 + 
 +  *   • **Refund** allows the user to perform a quick refund. The Refund Panel will display details about the transaction and will ask the user the amount and reason for the refund to be performed. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactions5.png?​400}} 
 + 
 +  *   • **Resend Cardholder Receipt** will open a panel with an input field asking for an email address. The user can click on the Update Cardholder email checkbox to update the email address used during the transaction. Also, in multi-language terminals, it will ask for a Receipt Language. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactions6.png?​400}} 
 + 
 +  *   • **Print Receipt** will open a panel where the user can select different languages (if available) and two buttons indicating if the user requires a Merchant ​Copy or a Cardholder Copy. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactions7.png?​400}} 
 + 
 +  *   • **Create Secure Card** allows the user to create a Secure Card using the same card used to perform the transaction. This is a handy option to create Subscriptions or additional sales using the same card in the future. This is enabled only in certain terminals. If you require this feature, please contact your vendor. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactions8.png?​400|}} 
 + 
 +  *   • **Create Subscription** after creating a Secure Card, the user can create a Subscription directly on Closed Batch. There is an option to change the Notification Language and to set a specific start and end date. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactions9.png?​400|}} 
 + 
 +====Batch Summary==== 
 + 
 +The Batch Summary will display information about the selected batch. It has the same details ​as the grouped batch summary covered in the Batch section. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchsummary.png|}} 
 + 
 +The first graph for single currency terminals is Net Total, with the total amount settled in the batch selected. For multicurrency terminalsthe Net Total is displayed in a bar chart indicating the volume of transactions separated by currency, on mouse over an information bubble will display the total amount ​for each currency. 
 + 
 +The second graph is a pie chart with information about the statuses of the transactions for the selected batch. 
 + 
 +The third graph is the volume of transactions per hour. 
 + 
 +Below the graphs, there is a table with a breakdown of transactions per currency with details about Charged Amount, Charged Transactions,​ Refunded Amount, Refunded Transactions and Net Total. Clicking on the arrow to the left, will break down the transactions for each currency per card brand (only card brands with transactions will display here). 
 + 
 + 
 +====Batch Transactions==== 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactionstab.png|}} 
 + 
 +In the Batch Transactions section you can search for a specific transaction within a batch. It also allows the use of Custom Fields in the search queries. The left bar indicates the status of that transaction and the arrow at the left displays further information about the transaction. Clicking on the Order ID will bring the transaction details. 
 + 
 +For each transaction available on screen, there are a number of actions available. The Actions Menu will appear when the user clicks on the dots [∙∙∙] menu. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactionstab2.png|}} 
 + 
 +**Transaction Details** to view additional information about a transaction. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactionstab3.png?​400|}} 
 + 
 +**Refund** allows the user to perform a quick refund. The Refund Panal will display details about the transaction and will ask the user the amount and reason for the refund to be performed. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactionstab4.png?​400|}} 
 + 
 +**Resend Cardholder Receipt** will open a panel with an input field asking for an email address. The user can click on the Update Cardholder email checkbox to update the email address used during the transaction. Also in multi-language terminals, it will ask for a Receipt Language. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactionstab5.png?​400|}} 
 + 
 +**Print Receipt** will open a panel where the user can select ​different ​languages (if available) and two button indicating if the user requires a Merchant Copy or a Cardholder Copy. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactionstab6.png?​400|}} 
 + 
 +**Create Secure Card** allows the user to create a Secure Card using the same card used to perform the transaction. This is a handy option to create Subscriptions or additional sales using the same card in the future. This is enabled only in certain terminals. If you require this feature, please contact your vendor. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactionstab7.png?​400|}} 
 + 
 +**Create Subscription** after creating a Secure Card, the user can create a Subscription directly on Closed Batch. There is an option to change the Notification Language and to set an specific start and end date. 
 + 
 +{{:​merchant:​existing_merchant:​selfcare_system:​closedbatchtransactionstab8.png?​400|}} 
 + 
 + 
 +===== Scheduled Report =====   
 + 
 +Scheduled Reports is a feature designed to facilitate the production of reports from past transactions processed by your terminals. Multiple Scheduled Reports can be created to suit your needs and the reports can be delivered by email or FTP. The Scheduled Report feature can be found after logging into the Selfcare system and is located under the Reporting section on the main menu
  
 {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_reports2.jpg|}} {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_reports2.jpg|}}
  
-**Creating a Report**+If the Scheduled Report is not available in your terminal, please contact the support team to activate the feature. 
 + 
 +====Creating a Report====
  
 To create a report, the Merchant only needs to inform the settings and at the given time, the report is going to be generated and delivered as configured. To create a report, the Merchant only needs to inform the settings and at the given time, the report is going to be generated and delivered as configured.
Line 177: Line 277:
   * *Custom reports may take up to an hour to be delivered.   * *Custom reports may take up to an hour to be delivered.
   * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_info.jpg|}}   * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_info.jpg|}}
- ​3. ​Select delivery method + ​3. ​Click **Save**.  
-  *  **Delivery Methods**: only two methods allowed ​- FTP and E-mail - and both require their specific details+ 
-  * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_delivery.jpg|}}+  * Please note that if you decided to produce a Once Off report, you will need to set the Start Date and End Date for your report. After the Once Off report is produced and delivered, it will be moved to the Inactive tab in the Schedule Report table. 
 + 
 + 4. Select how the Scheduled Report will be delivered and what information will be included in the reports. Click **Delivery Methods**
 + 
 + 
 +====Select Report Delivery Options==== 
 + 
 +There are two ways to receive your Scheduled Report, via email and FTP.  
 +  ​You can also receive your report using both options simultaneously.  
 +  - The reports are available on the Selfcare system in case you lose your email or your FTP server is offline.  
 + 
 +**Email Delivery** 
 + 
 + 1. To receive your Scheduled Report by email, select the **E-mail** checkbox. An input field will be shown, add the email address here.  
 +  ​To send to multiple email addresses, click **Add** ​and add a new email address.  
 +  ​- To remove one of the email addresses, click **Remove**.  
 +    -  
 + 2. After you finish adding all the email addresses, click **Save**. 
   * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_deliveryemail.jpg|}}   * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_deliveryemail.jpg|}}
- 4Build Report + 
-  * **Report Builder**: here you can choose, among a set of fields, the data to be used when filtering ​your report's desired information.+**FTP Delivery** 
 + 
 + 1To receive your Scheduled ​Report ​by FTP, click on the **FTP** checkbox. Fill the form with the details from your FTP server. ​   
 +  ​- Currently, the Scheduled Report feature supports accessing FTP servers with username and password.  
 + 2. Click **Save**. 
 + 
 +  * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_delivery.jpg|}} 
 + 
 + 
 +====Customize your Scheduled Report==== 
 + 
 +To customize the report with the information that suits your needs, click **Report Builder**. The section is divided into two parts.  
 + 
 +  - **Report Builder** ​ This functionality allows ​you to receive only transactions that are relevant for your reporte.g. only transactions with an amount greater than 100. You can add or remove filters clicking ​the "​**+**"​ or "​**-**"​ buttons.  
 +  - **Report Columns** In this area, you can choose what information is going to be available on your report. ​For example, you want to know the Card Type and Cardholder Email of all your transactions. You can also click **Select All** checkbox to receive all columns available in the report.  
   * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_builder.jpg|}}   * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_builder.jpg|}}
-  ​* **Report Columns**: those are the possible fields to appear in your report. +  * {{:​merchant:​existing_merchant:​selfcare_system:​scheduled_report4.png?300|}}
-  ​* {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_columns1.jpg|}} +
-  * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_columns2.jpg|}} +
-  * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​schedule_report_columns3.jpg|}}+
  
-**Edit a Report**+After selecting all the columns you need, click **Save** at the bottom of the screen to proceed. ​
  
-Click on link under Report ​Name column+====Completed Scheduled Report==== 
 + 
 +The Scheduled Report is ready and you will receive the report via the selected delivery method.  
 +  - If you have chosen the email delivery option, you will receive an email with a link to your report.  
 +  - If you have chosen to receive your report by FTP, your report will be available on your FTP server. 
 + 
 +====Scheduled Reports==== 
 + 
 +On the Scheduled Report page there are three different tabs: All, Active and Inactive.  
 +  - **Active** will show only the Schedule Reports currently running.  
 +  - If you created a Once Off report, after it has been delivered it will be moved to **Inactive**.  
 + 
 +**To Edit a Report**:  
 + 
 +Click on its name in the table. This will open a form similar to the one used to create the Scheduled ​Report. You can edit the information there, select new delivery methods, add additional emails or just check the information that is being used to create the report. ​
   * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​edit_schedule_reports.png|}}   * {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​edit_schedule_reports.png|}}
  
-**Delete a Report**+**To Delete a Report** 
 + 
 +On the Action column, there are different actions available.  
 +  - If the report is active, you can make it inactive by selecting **Set as Inactive**.  
 +  - In case you no longer need that report to be generated, you can select **Delete Scheduled Report**.  
 +  {{:​merchant:​existing_merchant:​selfcare_system:​set_inactive_scheduled_reports.png|}}
  
-Click on the horizontal ellipsis to display ​the options: Set as Inactive ​and Delete Scheduled Report+====Downloading Reports==== 
-  ​* {{:​merchant:​existing_merchant:​selfcare_system:​reporting:​delete_schedule_reports.png|}}+For each Scheduled Report, the latest report is available ​on Selfcare.  
 +On the Action column, click on the "​**...**" ​and there will be an option to download the latest report.  
 +  ​- The reports are generated in ZIP format containing a CSV file that can be opened in any spreadsheet software such as Microsoft Excel, Google Sheets or Apple Numbers
 \\ \\
  
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International