EBANX Dashboard

The EBANX Dashboard is a powerful tool for managing your payments and transactions. It provides real-time insights into transaction performance, allows you to access integration keys, configure notification URLs, monitor enrollment statuses, and generate detailed reports. Designed for seamless payment management, the dashboard enables you to track, analyze, and optimize your payment operations efficiently.

Requirements

Before you begin, ensure you have the following:

• Dashboard credentials - Ensure you have your dashboard credentials, or complete the Merchant Signup Form.
• Trouble with login - If you are having problems with login, request a password reset.

Dashboard Sections

Transactions

Review your Payments, Refunds, and Chargebacks transactions. Explore each section for detailed insights into their functionalities.

Payments and Refunds

• View Payments and Refunds - Use the top left buttons to toggle between list view and graphical format.
• Detailed Information - Click on any transaction to see complete details.
• Search Transactions - Find specific payments or refunds using order number, customer email, or payment hash.
• Filter Options - In the Payment sub-menu, filter transactions by country, payment method, or status.
• Time Period Filter - Adjust the display to show transactions within a specific time frame.
• Export Data - Download transaction lists in CSV or XLSX format.

Chargeback Disputes

• View Chargeback Transactions - Access all chargeback details.
• Dispute Chargebacks - Initiate disputes using the reason code "Commercial disagreement."
• Track Dispute Status - Monitor the progress of chargeback disputes.
• Filter and Use Tooltips - Apply filters and hover over tooltips to understand the displayed information.

Settlements

Preview settlement details and history.

Settlement Preview

View all available and pending amounts for settlements. Click View Details to simulate a settlement and review totals for collected amount, refunds, chargebacks, reversed chargebacks, and fees.

Settlement Details

Click Request Settlement to initiate a settlement for either all countries or a specific one.

Settlement History

• View settlements - Access all your settlements in either list or graphical format.
• Apply filters - Filter settlements by settlement code, time period, or status.
• Settlement details - Click a settlement to view details, processed amounts and fees.
• Export - Generate and export a detailed settlement report.

Logs

This menu displays all transaction communication records.

Direct API Log

This section shows all records sent from your platform to our API. Merchants using our external checkout will not see any data here. Use the search and filter options to find specific logs by payment number.

Notification Log View notification history from EBANX regarding transaction status changes. If you have not configured your notification URL, you will not see notifications.

• Notification URL
  • Allows EBANX to send real-time updates directly to your system, ensuring seamless communication.
    • Configure your Notification URL in the EBANX dashboard under Account Settings in the Integrations tab.
    • For detailed instructions, refer to the

      Payment Notification Guidechevron_right

Settings

Settings are located under your username in the top right corner of the screen. The menu includes the following.

• General Configuration - Update your company name, logo, and login details.
• User Configuration - Manage permissions for users within your company.
• Integration - Access your integration keys service URLs.
• Preferences - Set your time zone and default merchant (if applicable).

Single Sign-On (SSO)

The EBANX dashboard supports Single Sign-On (SSO) integration via Okta using OAuth2.

SSO Requirements

• OAuth2 authentication is available only to users with corporate domains.

• This integration allows pre-approved users with specific enterprise email domains (e.g. @your-company.com) to use Okta as the authentication provider.

• OAuth users must log in through SSO and cannot:

  • Log in using a traditional username and password.
  • Create or change passwords.

• Okta-integrated customers can have a mix of SSO users and non-SSO users.

• Integration requires users to be authorized on both platforms:

  • The user must be registered and assigned to the app in the Okta directory.
  • The user must be registered in the EBANX dashboard** with the same email address.

Instructions

1. Planning for SSO

   Before integrating your EBANX dashboard with OKTA, please review the following considerations.

   • Understanding SSO: How SSO works and how it can benefit your business.
   • Key Contacts: Identify the primary contacts in your organization who will collaborate with our team during the integration.
   • Integration Experience: Assess your company’s familiarity with similar integrations.
   • Technical Feasibility: Evaluate integration feasibility, considering any limitations in your Okta settings and directories.
   • Timeline Planning: Define expected deadlines for the integration.
   • Expectation Alignment: Set clear expectations and desired outcomes.

2. Permissions and roles

   Permissions and roles are managed at a different layer on the EBANX Dashboard. Performing login via Oauth or Login and password yields the same result as far as customer access. Roles and permissions are managed and still should be defined by the Permissions and Roles policies within the platform. Actions performed on Okta organizations such as user management, permission granting(e.g. assigning users to the custom app), and revoking must be done within OKTA directories.

3. Your responsibilities

   Create a Custom App for the EBANX Dashboard

   • Navigate to Applications > Create App Integration in Okta.

   Set up Allowed Sign-in Redirect URIs

   • Configure the redirect URL to direct users to the specified EBANX Dashboard tenant after login.

   • The URL will combine the base URI of the EBANX Dashboard and append the resource path.

     
     

   // Base URL
   https://dashboard.ebanx.com
   
   // Resource Path
   /users/auth/oktaoauth/callback
   
   // Base URL + Resource Path
   https://dashboard.ebanx.com/users/auth/oktaoauth/callback

   Set up the Initiate Login URI

   • At Okta, configure the 'Login Flow Option' to allow 'Either Okta or App' as initiators.
   • To obtain the Initiate Login URI for OAuth initiation, consult with the EBANX team.
   • Add the EBANX Dashboard app to users' dashboards to make it accessible.

   Save Your Client ID and Client Secret

   • These values from the custom app form are required by the EBANX team.

   Note Your Okta URL

   • Example: https://merchant.okta.com/ (required by the EBANX team).

   Review Custom Configurations

   • If your settings deviate from the defaults, take note of the following:

     • okta_issuer: The Okta server issuer URL.

       • Defaults to https://your-org.okta.com/.
       • For API management, it defaults to:
         • https://your-org.okta.com/oauth2/${authorizationServerId}.

     • okta_auth_server_id: The server ID used in your Okta Organization.

       • Defaults to: Null, unless using API management.

     • client_options / site: Your OAuth2 server URL.

       • Defaults to https://your-org.okta.com/oauth2.
       • For API management, it defaults to:
         • https://your-org.okta.com/oauth2/${authorizationServerId}.

     • client_options / authorize_url: The authorization server URL.

       • Defaults to https://your-org.okta.com/oauth2/v1/authorize.
       • For API management, it defaults to:
         • https://your-org.okta.com/oauth2/${authorizationServerId}/v1/authorize.

     • client_options / token_url: The URL to prompt for an access token.

       • Defaults to https://your-org.okta.com/oauth2/v1/token.
       • For API management, it defaults to:
         • https://your-org.okta.com/oauth2/${authorizationServerId}/v1/token.

   Create users for testing

   • Assign users to the EBANX dashboard application in your Okta organization directory.
     • Both users must be registered in the EBANX Dashboard using the same email address.
     • We recommend at least two users:
       1. EBANX User - Account for EBANX users to validate integration functionality and testing.
       2. Merchant User - Someone from your team to verify functionality (required).

   Send the Following to EBANX

   • Configurations, user credentials, and email domains for SSO login.
   • The EBANX team will then begin the integration process.

4. EBANX responsibilities

   After receiving the information from the previous step, the EBANX team will begin your integration with Okta. Throughout the process, the EBANX Dashboard team will stay in touch with your designated contacts to address any additional information requests or other matters that may arise.

5. Invite users

   Create via web interface

   You can add users directly through the EBANX Dashboard web interface:

   • Navigate to Account Settings > Users > New User.
   • Fill in the required details, select a permissions template, and click Create User.
   • The user will receive an invitation email and can log in via SSO.
   
   

   Create via spreadsheet upload

   To add multiple users at once:

   • Go to Account Settings > Users.
   • Scroll to the bottom of the page and click Add Multiple Users.
   • Upload an .xls or .xlsx file containing user information and assigned permissions.
   • Submit the spreadsheet, and all users will receive access and an invitation to the EBANX Dashboard.

6. Using the Integration

   To use the integration, you can start the login through the EBANX Dashboard or the Okta MyApps dashboard.

   • Login via EBANX dashboard:

     • Go to the EBANX Dashboard and click Login with Okta.
     • A window will prompt you to enter your company name.
     • If a match is found, you'll be redirected to the Okta authorization page.
     • Enter your credentials, and you’ll be logged into the EBANX Dashboard.

   • Login via Okta MyApps dashboard:

     • Log in to the Okta MyApps Dashboard and locate the EBANX Dashboard app.
     • Click on it, and a side panel will open with the Launch App button.
     • If not already logged in, you will be directed to the EBANX Dashboard login confirmation page for OAuth. Click Login, and you’ll be redirected to the Dashboard.
     • If you are already logged in, you will be automatically redirected to your company’s page on the Dashboard.

7. Frequently asked questions

   Can regular users without e-mail domains registered for Oauth login normally?

   • Yes.

   My company has SSO and I can't log in using Login and Password. What now?

   • You should click the "Login with Okta” button, type your company name on the text field and continue.

   Can I log in with Google through OKTA? Am I using Google or OKTA to log in?

   • Yes. While Okta handles identity verification for the EBANX Dashboard, Okta can also use Google to verify identities.
   • This means EBANX does not integrate directly with Google OAuth. Instead, Okta manages the Google OAuth integration.

   I see an unauthorized screen with an EBANX Dashboard URL. What does this mean?

   • This indicates that your user exists in your Organization directory, but you haven't been granted access to the EBANX Dashboard. Please contact someone in your company who has permission to invite users and request access.

   I see an unauthorized screen with an Okta URL. What does this mean?

   • This suggests that you are listed in your Organization directory, but you haven't been assigned to the EBANX Dashboard app in Okta. Reach out to your company's Okta administrator to be granted access to the app.

   Can a user log in through Okta without an enterprise email address (e.g., @gmail.com)?

   • No. SSO login is restricted to users with enterprise email addresses, which must be whitelisted in the EBANX Dashboard.

Multi-Factor Authentication (2FA)

The EBANX Dashboard provides two types of Multi-Factor Authentication (MFA):

1. Email
2. Google Authenticator App

Configuring Multi-Factor Authentication

To set up MFA, navigate to Settings and select the Preferences tab. You'll find the MFA field there, which is disabled by default.

To enable MFA, select your preferred verification method—Email or Google Authenticator App—and click Save in the user settings to begin the configuration process.

Email

If you select Email for 2FA and save, you will be logged out for security purposes.

• A verification code sent to your email will be required for your next login.
• This code is mandatory to complete the login process. The user has the option to resend the 2FA code.

Google Authenticator App

The verification code is required to complete the login process.

Users also have the option to view the QR code again.

At next login

During the next login, the user will need to complete an additional step by entering the code provided in the authenticator app.

Enabling MFA on the EBANX Dashboard adds an extra layer of security to your account.

Still need help?

We hope this article was helpful. If you still have questions, you can explore the following options:

• Merchant support: Contact our support team at sales.engineering@ebanx.com for assistance.
• Not a partner yet? Please complete the Merchant Signup Form, and our commercial team will reach out to you.