On This Page
About This Guide
This section describes this guide and where to find further information.
- Audience and Purpose
- This guide is intended for merchants on the Visa Acceptance platform.
- Conventions
- This statement appears in this document:AnImportantstatement contains information essential to successfully completing a task or learning a concept.
This guide instructs you on the introductory processes and best practices for the
partner platform, and it provides you with the core processes necessary to use it
effectively. It also contains training on the tools and systems designed
specifically for partner workflows, such as how to view and modify your profile
details, business information, payment settings, users' roles and permissions, and
API integrations, and describes additional platform processes and features.
Recent Revisions to This Guide
26.04.08
- Previous platform Version.
- Original platform interface systems documentation.
26.05.26
- Current platform Version.
- Updated documentation content for the platform's release.
Introduction to Settings
The Settings dashboard is your central hub for managing your account, business information, users, and integrations.
Welcome to the Settings User Guide for Visa Acceptance Solution for SMB! The Settings dashboard is your central hub for managing your account, business information, users, and integrations. This guide will help you navigate and utilize all the features available in Settings.
What is Settings?
Settings is a comprehensive management area where you can:
- Manage your profile.
- Update your personal information, password, and preferences.
- Configure business details.
- Set up your business contact information and branding.
- Control payment preferences.
- Choose your default currency for transactions.
- Administer users
- Add, edit, and manage user accounts and permissions.
- Handle integrations
- Generate and manage API keys for system integrations.
Settings Dashboard Overview
The Settings dashboard is organized into four main categories:
Personal
- My profile
- Manage your password, contact info, time zone, and username.
Account Management
- My business
- Update business name, address, phone, website, and logo.
- Payments
- Configure accepted methods, currency, and transaction type.
System Administration
- User management
- Add or manage your users and their permissions.
Technical
- Integrations
- Manage API keys for system integrations.
Important: User Permissions
Some settings can require specific user permissions to access or modify. If you cannot see or edit certain settings, contact your account administrator to verify your user role and permissions.
Settings Overview
This guide will help you use features available in the Settings dashboard.
What is the Settings Dashboard?
Manage the features through the settings dashboard:
- Your profile:Update your personal information, password, and preferences.
- Business details:Set up your business contact information and branding.
- Payment preferences:Choose your default currency for transactions.
- User accounts:Add, edit, and manage user accounts and permissions.
- Integrations:Generate and manage API keys for system integrations.
The Settings dashboard is organized into four main categories:
- Personal
- My profile:Manage your password, contact info, time zone, and username.
- Account Management
- My business:Update your business name, address, phone number, website, and logo.
- Payments:Configure accepted payment methods, currency, and transaction type.
- System Administration
- User management:Add or manage your users and their permissions.
- Technical
- Integrations:Create and manage API keys for system integrations.
User Permissions
Some settings require specific user permissions in order to access or modify them. If
you cannot see or edit certain settings, contact your account administrator to
verify your user role and permissions.
Your Account Settings
Follow these steps to access your account:
- Log in to your account.
- Click the Settings icon (
) in the navigation menu. The dashboard displays all available Settings for your account within the section tabs.
My Profile Overview
The My Profile section allows you to manage your personal account information, including your name, password, email address, mobile number, and timezone preferences.
Keeping your profile information up-to-date ensures you receive important notifications and can access your account securely.
Profile Information Overview
Your profile page displays:
- Name
- Your first and last name with an edit icon (✏).
- Email address
- Your email with verification status and edit icon.
- Mobile number
- Your phone number with verification status and edit icon.
- Preferences
- Your timezone setting.
- Change password
- Button to update your password.
Your email and mobile number will show either a green "Verified" badge or an orange "Not verified" badge. Verified contact information is important for account security and receiving notifications.
Password Requirements
Your new password must meet these requirements:
- Be 12-25 characters long.
- Cannot contain your username or organization ID.
- Must include both uppercase and lowercase letters.
- Must include at least one number.
- Must include at least one special character: ( ) . - _ # , ; / @ $ : & ! ? %.
- No other special characters are accepted.
Timezone Preferences
Your timezone setting affects:
- How transaction times are displayed in reports.
- When scheduled payments are processed.
- Timestamps on notifications and emails.
- Date/time displays throughout the platform.
Make sure to select the timezone where your business operates for accurate reporting.
Email and Mobile Verification
When you update your email address or mobile number, you must complete the verification process for the change to take effect.
If you do not receive the verification code:
- For email: Check your spam/junk folder and verify the address was entered correctly.
- For mobile: Verify your phone number was entered correctly with country code and that your phone can receive SMS messages.
- Use the resend code option if available.
If you do not complete verification, your contact information will show as "Not verified" and the change will not be finalized.
Accessing Profile Settings from Settings Dashboard
Access your personal profile settings from the Settings Dashboard.
- ClickSettingsin the left navigation menu.
- Click theMy profilecard in the Personal section.
Edit Your Profile Name
Follows these steps to update your first and last name in your profile:
- Navigate to your profile page using one of the following two methods:
ADDITIONAL INFORMATION
- Click on your profile name and avatar. Your profile page opens.
- ClickSettingsMy profilein the Personal section. Your profile page opens.
- Click the edit icon (
) next to your name.
- Enter yourFirst namein the first field.
- Enter yourLast namein the second field.
- ClickSave. A confirmation message opens.
Change Your Password
Follow these steps to update your account's password:
- Navigate to your profile page.
- ClickChange password. The Change password dialog opens.
- Enter your password in theCurrent passwordfield.
- Enter your new password in theNew passwordfield.
ADDITIONAL INFORMATION
Your password must meet these requirements:- Must be 12-25 characters long.
- Cannot contain your username or organization ID.
- Must include both uppercase and lowercase letters.
- Must include at least one number.
- Must include at least one special character: ( ). - _ # , ; / @ $ : & ! ? % .
- No other special characters are accepted.
- Re-enter your new password in theConfirm new passwordfield.
- ClickSave. A confirmation message opens.
Update Your Email Address
Follow these steps to change your profile's email address and verify the new
address:
- Navigate to your profile page.
- Click the edit icon (
) next to your email address. The Update email address dialog opens.
- Enter your email address in theNew email addressfield.
- Re-enter the email in theConfirm new email addressfield.
- Enter your current password for verification.
- ClickSave. A verification code is sent to your new email address.
- Check your email inbox for the verification code.
- Enter the verification code in the prompt.
- ClickVerify code.Your email will be updated and marked asVerified.
AFTER COMPLETING THE TASK
You must complete the verification process for your email change
to take effect. If you do not receive the verification code within a few minutes:
- Check your spam/junk folder.
- Click theResend codelink.
- Verify that the email address was entered correctly.
If you do not complete the verification process, your email will show the
status
Not verified
, and the change will not be finalized.Update Your Mobile Number
Follow these steps to change your mobile phone number and verify the new
number:
- Navigate to your profile page.
- Click the edit icon (
) next to your phone number. The Update mobile number dialog appears.
- Enter your mobile number in theNew mobile numberfield.
- Re-enter the number in theConfirm new mobile numberfield.
- Enter your current password for verification.
- ClickNext. A verification code is sent through SMS to your new mobile number.
- Enter the eight-digit verification code in the prompt.
- ClickSubmit. Your mobile number will be updated and its status changed toVerified.
ADDITIONAL INFORMATION
Similar to the email verification process, you must complete the SMS verification process. If you do not receive the code:- Verify that your phone number was entered correctly, including its country code.
- Check that your phone can receive SMS messages.
- Wait a few minutes. SMS delivery can sometimes be delayed.
- Try resending the code.
Set Your Time Zone Preference
Follow these steps to configure your time zone to ensure that your accurate date
and time show throughout the platform:
- Navigate to your profile page.
- Scroll down to thePreferencessection.
- Click theTime zonedrop-down menu.
- Choose your time zone from the list.
- ClickSave. A confirmation message opens.
My Business Overview
The My Business section allows you to manage your company's information, including business name, contact details, website, address, and logo.
This information can appear on customer receipts, invoices, and communications, so it is important to keep it accurate and professional.
Business Information Overview
The My Business page displays:
- Business name
- Your company's legal or trade name.
- Phone number
- Business contact phone with country code.
- Email address
- Business contact email.
- Website
- Your company website URL.
- Upload logo
- Section to add or update your business logo.
Business Logo Requirements
Your logo file must meet these requirements:
- File size
- Maximum 2 MB.
- File types accepted
- GIF, PNG, SVG, or JPEG only.
If your file does not meet these requirements, you will see an error message and need to adjust your file before uploading.
Accessing My Business
Access your business information page from the Settings Dashboard.
- ClickSettingsin the left navigation menu.
- Click theMy businesscard in the Account Management section.
Edit Business Contact Information
Follow these steps to update your business phone number, email address, and
website:
- Navigate to the My Business page.
- ClickEdit.
- Change your business phone number:
- Click the country code drop-down menu and choose your country.
- Click thePhone numberfield and enter the phone number.
- ClickSave. A confirmation message opens.
- Change your business email address:
- Click theEmail addressfield.
- Enter the new business email address.
- ClickSave. A confirmation message opens.
- Change your business website:
- Click in theWebsitefield.
- Enter the website URL.
- ClickSave. A confirmation message opens.
Upload or Change Your Business Logo
Follow these steps to add or update your business logo for customer-facing
materials:
- Navigate to the My Business page and scroll down to theUpload logosection.
- Upload your logo using one of these two methods:
ADDITIONAL INFORMATION
- Drag an image file from your computer and drop it into the upload box.
- Click theDrag and drop your logo or click to browsebox to open a file picker.
- Select your logo file. A preview of the image appears in the upload box.
- ClickSave. A confirmation message opens.
ADDITIONAL INFORMATION
Your logo file must meet these requirements:- File size:Maximum 2 MB.
- Fie types accepted:GIF,PNG,SVG, orJPEGonly.
If your file does not meet these requirements, an error message appears. This message indicates that you must choose another file or modify the current file before uploading.
Payment Settings Overview
The Payment Settings section allows you to configure your default currency for transactions.
This setting determines how amounts are displayed and processed throughout the platform.
Currency Considerations
When selecting your default currency:
- Choose the currency you primarily do business in.
- This affects how amounts are displayed in reports and dashboards.
- Individual transactions can still be processed in different currencies.
- Currency conversion rates apply when processing non-default currencies.
Available Currencies
- United States Dollar
- Code: USDSymbol: $Best For: Businesses primarily operating in the United States.
- Canadian Dollar
- Code: CADSymbol: $Best For: Businesses primarily operating in Canada.
Even if you set USD as your default currency, you can still accept payments in CAD and other supported currencies. The default currency primarily affects reporting and display preferences.
Accessing Payment Settings
Access the Payment Settings page to configure your default currency.
Setting your default currency ensures that transaction amounts are displayed correctly in reports and dashboards.
- ClickSettingsin the left navigation menu.
- Click thePaymentscard in the Account Management section.
Set Your Default Currency
Follow these steps to configure your default currency for displaying amounts in
reports and dashboards:
- ClickSettings.
- in the Account Management section, clickPayments.
- Click theDefault currencydrop-down menu.
- Choose your default currency from the list:
- USD - United States Dollar
- CAD - Canadian Dollar
- ClickSave. A confirmation message opens.
User Management Overview
The User Management section is where you control access to your Visa Acceptance Solution for SMB account.
You can add new users, assign roles and permissions, edit user information, and manage user status. Proper user management is essential for security and operational efficiency.
User Management Page Structure
The User Management page has two main tabs:
- Users
- View and manage individual user accounts.
- Roles & Permissions
- View available roles and their associated permissions.
The Users tab displays a table with:
- Date created
- When the user account was created.
- Username
- The user's login username.
- Name
- The user's full name.
- Role
- The assigned role (Admin, Manager, etc.)
- Email
- The user's email address.
- Status
- Active or Inactive.
- Actions
- Three-dot menu for managing the user.
Understanding Roles and Permissions
Common user roles include:
- Owner
- Full access to all features and settings.
- Admin
- Can manage transactions, managing 3rd Party Integration, and view and download reports, limited settings access, viewing & managing Billing and paying Bills.
- Limit
- Basic access to accepting and process transactions, viewing limited reports.
Note: Specific roles and permissions can vary based on your account configuration.
User Verification
After you add a user:
- A verification email is automatically sent to the user's email address.
- The user must click the verification link within 24 hours.
- If they do not verify within 24 hours, you will need to resend the invitation or create a new user.
- The user will set their own password during the verification process.
Disable vs. Delete
- Disable
- Temporarily prevents login but preserves the user account and history. Use this for employees on leave or temporary access removal.
- Delete
- Permanently removes the user account. Use this only when you are certain the user will never need access again. Deleting a user cannot be undone.
Accessing User Management
Access the User Management page to add, edit, and manage user accounts.
- ClickSettingsin the left navigation menu.
- Click theUser managementcard in the System Administration section.
View Roles and Permissions
Follow these steps to view user roles and their permissions:
- Navigate toUser Management.
- Click theRoles and Permissionstab to review the available roles and their descriptions.
- Click on any role to see detailed permissions.
Add a New User
Follow these steps to create a new user account and assign a role:
- Navigate to User ManagementUsers.
- ClickAdd user. The Add user dialog opens.
- Fill in the required information:
- First name:User's first name.
- Last name:User's last name.
- Username:Login username (must be unique).
- Email address:User's email (must be unique).
- Phone number:User's contact phone.
- Click theSelect a roledrop-down menu.
- Choose the appropriate role for the user.
- (Optional) ClickView role permissionsto review what the role can do.
- (Optional) Enter aJob titlefor the user.
- ClickAdd user. A confirmation message opens.
ADDITIONAL INFORMATION
After you add a user:- A verification email is automatically sent to the user's email address.
- The user must click the verification link within 24 hours.
- If they do not verify within 24 hours, you must resend the invitation or create a new user.
- The user will set their own password during the verification process.
Edit User Information
Follow these steps to update user details including name, role, and job
title:
- Navigate to User Management and find the user in the list.
- Click the user's name or row. The User profile page opens.
- To edit the user's name, click the edit icon (
) next to the user's name.
- Enter the new first and last name.
- ClickSave. A confirmation message opens.
Searching for Users by Name or Email
Search for specific users by their name or email address.
Use the search function to quickly locate users in your organization.
- Click in the "Search user by name or email" field at the top.
- Type the user's name or email address.
Step Result
The list will filter automatically as you type.
Sorting Users by Column
Sort the user list by various columns to organize and find information.
- Click any column header (Date created, Username, Name, Role, Email, Status).
ADDITIONAL INFORMATION
- Click once for ascending order.
- Click twice for descending order.
- Click a third time to reset to default order.
Enabling a User
Reactivate a disabled user account to restore their access.
Enable a user to restore their access to the system.
- Find a user with Inactive status.
- Click the three-dot menu (⋯) in the Actions column.
- ClickEnable.
- In the confirmation dialog, clickEnableagain.
Step Result
The user's status changes to Active.
Disabling a User
Temporarily disable a user account to revoke their access.
Disable a user to temporarily revoke their access while preserving their account.
- Find a user with Active status.
- Click the three-dot menu (⋯) in the Actions column.
- ClickDisable.
- In the confirmation dialog, clickDisableagain.
Step Result
The user's status changes to Inactive.
Deleting a User
Permanently remove a user account from the system.
Delete a user to permanently remove their account. This action cannot be undone.
- Find the user you want to delete.
- Click the three-dot menu (⋯) in the Actions column.
- ClickDelete.
- In the confirmation dialog, clickDeleteagain.
Step Result
The user is permanently removed from the system.
Integrations Overview
The Integrations section is where you generate and manage REST API security keys for connecting external systems to your account.
API keys enable secure communication when sending and receiving REST API messages for automated payment processing, reporting, and other integrations.
Understanding REST API Keys
REST API security keys enable secure authentication when your systems communicate with the Visa Acceptance Solution for SMB API. There are two types of keys available:
- Shared Secret
- Authentication Method: HTTP Signature Authentication.Best For: Simple integrations, quick setup.Complexity: Low - Easy to implement.
- Certificate
- Authentication Method: JSON Web Token (JWT) Authentication.Best For: Enterprise integrations, highest security.Complexity: Medium - Requires certificate management.
REST API Key Security Best Practices
REST API keys are like passwords for your systems:
- Never share keys
- Never share keys with unauthorized parties.
- Store securely
- Use secure credential management systems.
- Separate environments
- Use different keys for test and production.
- Key expiration
- Keys expire after 3 years. Plan for renewal before expiration.
- Rotate regularly
- Generate new keys periodically for security.
Integrations Page Overview
The Integrations page displays a table of all your API keys with:
- Key ID
- Unique identifier for the key.
- Key type
- REST - Shared Secret or REST - Certificate.
- Status
- Active or Expired.
- Created
- Date the key was generated.
- Expires
- Expiration date (3 years from creation)
- Actions
- Three-dot menu for managing the key.
If you have not created any keys yet, you will see an empty state with a message: "No keys found" and a button to create your first key.
Certificate Key Information
Certificate keys generate a public-private key pair:
- The private key is stored in the .p12 file you download.
- The public key is stored on the Visa servers.
- Your integration uses the private key to sign requests.
- The server uses the public key to verify the signature.
- This provides strong authentication without transmitting secrets.
Using API Keys in Your Integration
For Shared Secret Keys:
Your integration code will need:
- Key ID
- Include in the API request header.
- Shared Secret
- Use to generate the HTTP signature.
- Merchant ID
- Your account identifier.
For Certificate Keys:
Your integration code will need:
- Key ID
- Include in the API request header.
- .p12 file
- Load into your application.
- Password
- To decrypt the .p12 file.
- Merchant ID
- Your account identifier.
Refer to the Visa Acceptance Solution for SMB API documentation for code samples, authentication implementation guides, API endpoint references, and testing tips.
Key Expiration and Renewal
All REST API keys expire after 3 years. To prepare for expiration:
60 Days Before Expiration:
- Generate a new key of the same type.
- Test the new key in your development environment.
- Update your integration code to use the new key.
- Deploy the updated code to production.
- Verify the new key is working correctly.
- Keep the old key active as a backup.
After Successful Transition:
- Monitor for any issues for 1-2 weeks.
- Once confident, delete the old expired key.
- Update your key inventory documentation.
You can have multiple active keys at the same time. This allows you to transition gradually between old and new keys, have different keys for different integrations, and maintain a backup key in case of issues.
Important: Shared Secret Visibility
You can only view the Shared secret value ONCE during creation. After you close the creation dialog:
- The secret value cannot be retrieved again.
- If you lose it, you need to delete the key and create a new one.
- Always download or copy both the Key ID and Shared secret before closing.
- Store them securely in your credential management system.
Key Deletion Impact
When you delete a key:
- Any integrations using that key will immediately stop working.
- The deletion cannot be undone.
- You need to generate a new key and update your integrations.
- Plan deletions carefully to avoid service disruptions.
Accessing Integrations
Access the Integrations page to manage API keys used for secure communication.
The Integrations page allows you to manage API keys used for secure communication between your systems and the platform.
- ClickSettingsin the navigation menu.
- Click theIntegrationscard in the Technical section.
View REST Keys
Follow these steps to view existing REST API keys:
- From the Settings tab, clickIntegrations.
- To view a specific key, click the row containing it.
- To copy the Key ID, click theCopybutton (
). A verification message opens.
Search REST Keys
Follow these steps to search for a specific REST API key:
- From the Settings tab, clickIntegrations.
- Select theSearch keystext field.
- Enter a Key ID. The entered key appears.
ADDITIONAL INFORMATION
No input type other than an API Key ID produces search results.
Filter REST Keys
Follow these steps to filter the displayed REST API keys:
- From the Settings tab, clickIntegrations.
- To filter REST keys by type, click theKey Type:drop-down menu. Follow one or both of these options:
ADDITIONAL INFORMATION
- To filter the keys by REST - Shared Secret, check the box next to this option.
- To filter the keys by REST - Certificate, check the box next to this option.
- When filtering keys by the below variables, ensure that the Select all box is not checked.To filter REST keys by status, click theStatus:drop-down menu. Follow one or both of these options:
ADDITIONAL INFORMATION
- To filter the keys byActivestatus, check the box next to this option.
- To filter the keys byExpiredstatus, check the box next to this option.
Download Keys
Follow these steps to download a key:
- From the Settings tab, clickIntegrations.
- Click the row containing the key you choose to download.
- In the Key details pane, click theDownload keybutton (
). A download result prompt or confirmation message appears in your browser, showing the key downloaded as a
.txtfile.
Delete Keys
Follow these steps to delete a key:
- From the Settings tab, clickIntegrations.
- To delete a key, follow one of these two methods, and then proceed toStep 3.
ADDITIONAL INFORMATION
- Click the row containing the key you choose to delete. When the Key details pane displays, click theDelete keybutton (
).
- Click the three-dot menu icon (
) in the Actions column for the key, and click
Delete.
- At the confirmation prompt, clickDelete. A verification message appears.
Create a Certificate
Follow these steps to generate a new Certificate:
- From the Settings tab, clickIntegrations.
- Click theCreate Keybutton (
).
- Select the key typeCertificate, and clickGenerate key.
- Click theDownloadbutton (
).
- When theProtect your key file with a passworddialog box opens, create a password.
ADDITIONAL INFORMATION
Your password must follow these requirements:- Must be 12-25 characters long.
- Cannot contain your username or organization ID.
- Must include both uppercase and lowercase letters.
- Must include at least one number.
- Must include at least one special character: ( ). - _ # , ; / @ $ : & ! ? % .
- No other special characters are accepted.
- ClickDownload key. The.p12file downloads to your system. If prompted by your system, approve or select the download location.
- Click the downloaded file to initiate the key generation process.
- When prompted to either save or open the file, selectOpen, and follow the prompts to create and activate a new security key.
- (Optional) Return to theKey created successfullyprompt. Select the public PEM-formatted (Privacy Enhanced Mail) certificate text field, and provide the Public PEM-formatted certificate information.
ADDITIONAL INFORMATION
If no Public PEM-formatted certificate information is provided, a public-private key pair is generated in your browser and secured in a.p12file.
Glossary
A
- Active
- A status indicating that a user account or API key is currently operational and can be used.
- Administrator
- A user role with full access to all Settings features and the ability to manage other users.
- API (Application Programming Interface)
- A set of protocols that allows different software applications to communicate with each other.
- API Key
- A unique identifier used to authenticate API requests from your systems to the platform.
- Authentication
- The process of verifying the identity of a user or system.
C
- Certificate Key
- An API key type that uses JSON Web Token (JWT) authentication with public-private key pairs.
- Credential Management
- The practice of securely storing and managing passwords, API keys, and other sensitive authentication information.
D
- Disable
- To temporarily deactivate a user account, preventing login while preserving the account data.
E
- Expired
- A status indicating that an API key has passed its expiration date and can no longer be used.
H
- HTTP Signature Authentication
- An authentication method that uses a shared secret to generate and verify request signatures.
I
- Inactive
- A status indicating that a user account has been disabled and cannot be used to log in to the platform.
- Integration
- The connection between the platform and external systems or applications.
J
- JSON Web Token (JWT)
- A compact, URL-safe means of representing claims to be transferred between two parties, used in Certificate key authentication.
K
- Key ID
- A unique identifier for an API key, used in API request headers.
- Key Rotation
- The security practice of periodically generating new API keys and decommissioning old ones.
L
- Least Privilege
- A security principle where users are given only the minimum access rights needed to perform their job functions.
M
- Merchant ID
- A unique identifier for your business account on the platform.
P
- Permissions
- Specific actions or access rights granted to a user role.
- Public PEM Certificate
- A public key certificate in Privacy-Enhanced Mail (PEM) format.
R
- REST API
- Representational State Transfer Application Programming Interface, a web service architecture used for system integrations.
- Role
- A predefined set of permissions that can be assigned to users.
S
- Shared Secret
- An API key type that uses a secret value known to both parties for HTTP signature authentication.
- Signature
- A cryptographic value generated using a secret key to verify the authenticity of an API request.
T
- Timezone
- The geographic region's time standard used for displaying dates and times in the platform.
- Two-Factor Authentication (2FA)
- A security process requiring two different forms of identification to verify a user's identity.
U
- User
- An individual with an account and assigned permissions to access the platform.
V
- Verification
- The process of confirming the validity of contact information (email or phone) by entering a code sent to that address.