Switch Dashboard

Centralized overview and full control of your payment operation.

The Switch Dashboard offers a comprehensive and user-friendly interface to support your payment strategy. By allowing Merchants to quickly interact with Transactions, study Analytics, and tap into Settlements and Reports, the Switch Dashboard makes setting up and managing your payment operation much simpler, quicker, and straightforward.

Analytics

The insights provided by the Analytics’ tab allow Merchants to verify the status of Transactions and spot opportunities for transaction optimization. At the same time, this part of the Switch Dashboard offers an in-depth look at the landscape of Merchants’ Transactions, be it by location, time, or device.

This overview can show results from a specific date or summarize the data acquired over the week, month, or year.

Filters can aid navigation in the Analytics tab. These filters refer to Payment Methods employed, currency, and country, and device used for Payment. It is also possible to filter by the success or failure of the Transactions and by date.

FilterDescription
Payment MethodThe Payment method dropdown mirrors the chosen channels. The user is able to compare Transactions between channels and understand the status of each Payment Method in regards to its Merchant. (e.g. Alipay, Paypal, Sofort).
CurrencyThe currency applied to Transactions can also filter the results presented in the Analytics tab.
CountryUnderstanding the landscape of Transactions for particular countries or groups of countries may prove very useful for Merchants.
DeviceConsumers’ choice of device for payments allows merchants to understand which platforms bring in more or less Payments. (Desktop, Tablet, Mobile).
Success/ErrorAnalytics on successful Transactions and failed Transactions are available to the user through filtering.
Dates GranularityUsers can compare the Payment’s flow between different hours, days, months or years.
Start Date and End DateUsers can also tap into the Payments’ flow over a specific period of time by setting up a start and an end date to their Analytics results.
CompareUsers can compare all the Analytics results from two instance perspectives. This means it is possible to compare the Transactions between two different payment methods, currencies, countries, devices or periods of time.

The first data display shown in Analytics is balance. Here users can check the total volume of transactions and the total number of payments over a day, week, month, or year.

In the Dashboard, users can tap into all sorts of additional information. This includes the percentage of refunds, the acceptance rate, and the average Transaction amount, and the average Payment fees. The unsettled balance is also on display so Merchants can check the amount of funds still outstanding throughout their Providers’ base.

Details on Transactions range from the split of Payment Methods used, the currency applied and the device used for payment credential collection in the transaction. Information like this is useful to the user as it provides insight into customers’ payment environment.

It is also possible to understand the geographical source of Payments by paying attention to the mapped distribution per country. Customers’ locations appear listed on this interactive display.

Transactions

When it is time to dive deep into the Transactions going through your Payment Channels, everything is laid out for you on the Transactions tab. This includes Payment Methods, Providers involved, and the status of Transactions. Merchants can generate reports with the data they see fit and export particular transactions.

Whilst generating a Report, it is possible to select the metadata and parameters you are looking for, be it for Charges, Instruments or Payments. After filtering transaction data, it’s possible to export both in a CSV or Excel file. You can observe transactions through a simple Charge-Instrument-Payment logic or pinpointing all Lifecycle Events.

When watching out for transactions, quickly understanding the status of each one is very important. There are five possible statutes for transactions in the Switch Dashboard. Invalid instruments are highlighted by default.

StatusDescription
ConfirmedCharge confirmed.
SuccessPayment successful.
AuthorizedInstrument authorized.
PendingInstrument pending.
InvalidInstrument invalid.

When consulting a Charge, you can find its id, amount, currency and status in the header. The Channel through which it was processed and the details from the request log which include the consumer’s IP address and country. The Risk Rules and how the Charge abides by them or not can also be found in the Charge details.

Going into the details of each registered Instrument, you can observe its respective Charge, as well as the amount, currency and id. Besides the details already granted by the Charge, you will get access to the Instrument parameters, which describe the authentication parameters provided by your Customer, as long as they do not fall under the scope of sensitive data according to the relevant Payment Scheme, in which case we will not expose them for security reasons.

Following the Instrument comes the Payment, which is also registered with every Transaction and includes the results of the Payment process. Through the Payment page, you can also generate Refunds, be it full Refunds or partial Refunds.

Settlements

The Settlements tab includes which funds have been notified by the Provider as being transferred to the designated Merchant bank(s) account(s). You can export settlement data, be it the entire record of settlement or settlements filtered by Charge, Instrument, or Payment parameters.

Each settlement is associated with a specific Provider, which is responsible for said settlement. You can access Providers’ statements through the Sources subtab. Settlement information includes the number of Transactions settled, Transactions not found, Refund settlements, and Dispute settlements.

The agreements settled between Merchants and Providers that rule the settlements listed can be accessed under Agreements. These include Payment Methods, the Provider, and the agreed processing rates under each Merchant Agreement signed directly between the Merchants the respective Provider, which shall be configured on each Channel.

Risk

Risk is all about identifying dubious transactions. It can be relevant to set rules which pinpoint what Payments you need to give extra attention to or even reject altogether. On the Risk management portion of the Dashboard, you can find Risk results attributed to specific reasons. These reasons derive from the Risk Rules created by you.

Risky Transactions are classified as reviewed and blocked. Once a Risk Rule is activated, you can analyze the respective transaction, understand if it must be blocked, or if it needs to be refunded and proceed accordingly. Afterward, you can mark the Transaction as reviewed.

There are different types of Risk Rules. To add a new rule, edit a previous one, or have access to the list of rules, you should tap into the Rules and Providers Page.

Rule TypeDescription
Allow RuleAllow all transactions that match the parameters set.
Block RuleBlock all transactions that match the parameters set.
Review RuleAll transactions that match the parameters set pending review.
Enable 3DSEnable 3D Secure for all transactions that match the parameters set.

Before applying rules you can test them in the Test tab. This is useful to understand the rules you can create, the fields they can have and if they apply correctly to the Transactions you are trying to avoid.

Channels

One of the great advantages of the Switch Dashboard is that you can quickly pick and choose the Payment Methods available to your Customers. The available list depends on the available Providers with which you establish a direct Merchant Agreement. Nonetheless, you can add and remove Channels without fuss and quickly customize your users' checkout experience. This freedom of Channels allows you to quickly adapt your interface and payment strategy and immediately present it to your Customers.

Another advantage of the Channels is that you can segment your Customers’ Transactions by Payment Method through the configuration of Routing Rules. This can have advantages concerning your Transaction profile (e.g. amount, issuing country, currency, etc.), and the fees applied to your Transactions according to each Merchant Agreement.

Terminals

Under terminals, you can find the list of Terminals available to your customers, including Terminal Model and serial number. You can also change the Terminal settings in this section by adding new terminal models. You can also include the language used, the daily session end time, and the supervisor and maintenance PINs.

Events

Under events, you can find all the Lifecycle Events derived from your Transactions. These are listed by date and include the type of event, its id, and its status. Each event is usually associated with a flow of Charge, Instrument, and Payment and a specific webhook URL, you can find details for each of these on Event Handling. Events are useful to locate specific instances in your transactions and also understand their source and where they could have failed in case they reveal themselves to be invalid. You can also search for events by event ID or Webhook status.

Additionally, the Events' tab can be used by your development team for integrations purposes and troubleshooting issues with infrastructure communications.

Event TypeDescription
Charge CreatedWhen a Customer proceeds with a purchase a charge is created for said purchase. This event includes the amount and date of this action. It also generates an id, Webhook and eventURL in the response code.
Instrument AuthorizedInstruments show the associated Charges created for the purchase they are used for.
Instrument InvalidInstrument invalid events pinpoint an instrument that was rejected either because it does not comply with Risk Rules, or because the Instrument itself is not valid.
PaymentPayment settled events refer to Payments that have already gone through. Payment events have a Charge and Instrument associated.
RefundRefund events are generated when a user chooses to generate a full or partial Refund for a purchase.

Reporting

Under Reporting, you can set report templates for your Transactions. Through these report templates, you can download transaction data that is recurrently necessary to your operations or make a note of a specific sales strategy or Payment’s time frame. Reports allow you to map out total Transactions for a specific date, understand the average amount per transaction, and the total profit. You can limit reports to a specific currency, charge_type, and transaction_type.

Dashboard Settings

The first step when finding your ground in the Switch Dashboard is selecting the Merchant Account. Merchant Accounts can figure at different levels, depending on whether they are main Merchant or Submerchant Accounts. After selecting the Merchant Account, users can access all the information the Dashboard has to offer on said Merchant Account and go over all the available actionable items, which include the Platform Components previously mentioned.

Account Details

Under the User’s Account option, it is possible to find account details, like name and email, and the set up two-factor authentication. One important detail to consider under Account is the personalization board. Here the user can select the language of the Dashboard, the time zone, the date format, and the state of the Merchant API (Live, Staging, Custom).

Account Details

In Account Details you can register the User-specific fields and personalize User profile.

Name, Email, Password.
Two Factor Authentication

The Switch Dashboard offers Two Factor Authentication. It is under Account that you can generate the respective codes and register trusted devices.

Codes, Trusted Devices.
Personalization

You can change the language, time zone, and date format using your Account settings.

Language, Timezone, Date Format, Merchant API.

Merchants

You can search for existing Merchants by name under your Dashboard's logotype. To get access to the full list of merchants and respective account names and account id access the Merchants tab.

Merchant information is condensed in the Merchants tab. Here you can find the main merchant, its account id, and environment. You can also find the list of Submerchant Accounts, in case they exist, and search and manage said Submerchant Accounts.

Merchant Details

You can come back to Merchant details to check your Environment, TEST/LIVE and your account id.

Environment, Account id, Approval.
Billing

Billing settings can be found under Merchant. In this section you can go over your billing history and set up a billing schedule.

History, Schedule, Frequency.
Submerchants

In the Merchants tab you can get an overview of your Submerchant Accounts and access each of them for further details or to proceed with changes, namely to billing.

Account Name, Account id.

Settings

Looking for more information about Users and Authorization Groups?

Visit Merchant for more details on how to manage your team.

In Settings, you can create Processing API Keys and Merchant API Keys and manage the ones already in use. Settings also include permissions and authorization groups for users. This is the part of the Dashboard where you can hand out different permissions to different members of your organization so that they can access all the different Dashboard tools.

Processing API Keys

The Processing API Key set includes the Public Key and Private Key used during Authentication.

Description, Status.
Merchant API Keys

Merchant API Keys can be set per Authorization Group. These are necessary to manage different accounts and Users inside your operation.

Description, Status.
Users

In the Merchants tab you can get an overview of your Submerchant Accounts and access each of them for further details or to proceed with changes, namely to billing.

Account Name, Email Address, Account id.

Whitelabel

Are you interested in enabling Whitelabel for your business?

Whitelabel is paid feature, please reach out to our Sales Team for more information on how to proceed.

The Switch Dashboard can be rebranded to match your brand. In Whitelabel Settings you are able to define which components should be styled and how they should be configured. Whitelabels are devised to aid Acquirers/PSPs/Gateways/ISVs in displaying their own unique brand to their associated Submerchants.

Currently, the Switch Dashboard elements available for changes under Whitelabel settings are logotypes, color scheme, favicons, and links to external sources.

ElementDescription
LogotypeAll logotype images in the Dashboard can be changed to fit the brand.
Color SchemeChanges to the colors displayed in buttons, backgrounds, notifications and critical information are available for further customization.
Browser FeaturesFavicon options and text displayed on tabs and address bars can be made to fit the client’s navigation needs.
External HyperlinksLinks to external resources can be added to the sidebar as means to complement the client’s use of the Switch Dashboard.

Logotype

Logotypes are displayed upon login into the Dashboard and also when loading the next screen. These can be formatted to figure the merchant logo instead of the Switch brand. It is important to keep in mind that the logo should have the appropriate dimensions, resolution, and color scheme to be properly displayed in the login screen background.

After login, users can see the chosen logo on the upper left corner of the Dashboard. Currently, this is the only instance where the logo is displayed inside the platform.

ADD LOGOTYPE IMAGE
"images": {
"image_sidebar_logo": "assets/img/yourlogo.png",
"image_sidebar_logo_light": "assets/img/yourlogo.png"
}

For applications in the Switch Dashboard it is recommended a logo with a horizontal layout, height: 150px and width: 500px.

Color Scheme

The color scheme Whitelabel options are designed to put the client’s identity front and center by allowing the user to explore multiple color palette applications. Additionally, color can be an effective tool to highlight important information, this is particularly relevant in the analytics section.

Customizable options were devised to give options to the user while keeping the Dashboard’s design integrity and functionality.

SETTING COLOR SCHEME
"colors": {
"primary_color": "#8578D0",
"on_primary_color": "#FFFFFF",
"background_color": "#F9F9FA",
"success_color": "#8cba93",
"warning_color": "#ddb05f",
"error_color": "#bc5555",
}

Buttons and Icons

The color icons on the main menu on the left are defined as the primary_color. Buttons, namely the ones displayed on the top right corner of the Dashboard also change color according to the value set on primary_color. The text displayed on top of these buttons can go through a color change using on_primary_color.

Background

The Switch Dashboard includes two display levels. The background displays basic features like the menu options and titles for sections. At surface level, there is actionable information for the user, namely in dropdown menus and pop-ups. You can make changes to the background_color so it better fits your brand.

Status

The status of transactions is highlighted in a particular color to make it stand out. You can define different colors for a success status (e.g. confirmed, authorized, success) and an error status update (e.g. invalid), just use success_color and error_color.

Warnings

warning_color is important when it comes to highlighting warnings and notifications on your dashboard. To immediately spot a problem that requires action in the transactions section is very relevant.

Whatever the color scheme users find fit for the Dashboard, it is important to pay particular attention to Warnings and Error display colors. The notifications in these sections usually need immediate attention and should stand out amongst all the other Dashboard information.

Browser Features

Favicons allow the display of a brand in the search bar, allowing users to tab back and forth between the Dashboard and other sites quicker. It is also possible to change the HTML title to fit your brand.

ADD FAVICON
"javascript": {
"client_name": "[Client name]",
"logos": {
"android_favicon_192x192": "[image path/location]",
"apple_favicon_57x57": "assets/img/favicon.png",
"apple_favicon_60x60": "assets/img/favicon.png",
"apple_favicon_72x72": "assets/img/favicon.png",
"apple_favicon_76x76": "assets/img/favicon.png",
"apple_favicon_114x114": "assets/img/favicon.png",
"apple_favicon_120x120": "assets/img/favicon.png",
"apple_favicon_144x144": "assets/img/favicon.png",
"apple_favicon_152x152": "assets/img/favicon.png",
"apple_favicon_180x180": "assets/img/favicon.png",
"favicon": "assets/img/favicon.png",
"favicon_16x16": "assets/img/favicon.png",
"favicon_32x32": "assets/img/favicon.png",
"favicon_96x96": "assets/img/favicon.png",
"ms_icon_144x144": "assets/img/favicon.png",
"splash": "assets/img/favicon.png"
}
}

It is possible to add links to the bottom menu button. These should be used sparsely to ease user’s access to external information that is relevant to their work, including other company resources or relevant policies.

ADD EXTERNAL LINKS
"links": {
"documentation": "https://switchpayments.com/docs"
"support": "mailto:support@switchpayments.com"
}

It is best to stick to important hyperlinks in this section so as not to crowd the menu with unnecessary information. A maximum number of three additional links is advisable.

Configuring the Whitelabel

The Whitelabel configurations can be accessed on the Dashboard under “Settings” where you can create a new Whitabel Setting. Find below a JSON example of what can be imputed on the “Dashboard config” text box.

The option to activate the Whitelabel settings can be found on the Merchants page. Select this option under “Edit Merchant”.

WHITELABEL EXAMPLE
{
"css":{
"colors":{
"primary_color":"#8578D0",
"on_primary_color":"#FFFFFF",
"background_color":"#F9F9FA",
"success_color":"#8cba93",
"warning_color":"#ddb05f",
"error_color":"#bc5555"
},
"images":{
"image_sidebar_logo":"assets/img/yourlogo.png",
"image_sidebar_logo_light":"assets/img/yourlogo.png"
}
},
"javascript":{
"client_name":"[Client name]",
"logos":{
"android_favicon_192x192":"[image path/location]",
"apple_favicon_57x57":"assets/img/favicon.png",
"apple_favicon_60x60":"assets/img/favicon.png",
"apple_favicon_72x72":"assets/img/favicon.png",
"apple_favicon_76x76":"assets/img/favicon.png",
"apple_favicon_114x114":"assets/img/favicon.png",
"apple_favicon_120x120":"assets/img/favicon.png",
"apple_favicon_144x144":"assets/img/favicon.png",
"apple_favicon_152x152":"assets/img/favicon.png",
"apple_favicon_180x180":"assets/img/favicon.png",
"favicon":"assets/img/favicon.png",
"favicon_16x16":"assets/img/favicon.png",
"favicon_32x32":"assets/img/favicon.png",
"favicon_96x96":"assets/img/favicon.png",
"ms_icon_144x144":"assets/img/favicon.png",
"splash":"assets/img/favicon.png"
},
"links":{
"documentation":"https://switchpayments.com/docs",
"support":"mailto:support@switchpayments.com"
}
}
}