MyBridgePay Custom Roles User Guide
Introduction
Custom Roles are a feature of MyBridgePay whereby Reseller and Sales Agent organizations can create and manage their own custom roles for use within their own hierarchy. Custom roles are linked to a single user type during the create process and cannot be assigned to multiple user types.
User Types
Reseller
Sales Agent
Merchant Group
Merchant Account
Custom Roles can be created and applied for use in several ways, such as:
As a replacement user role(s) for the MyBridgePay default system roles.
As a functional or combined/multi-functional based role (i.e. a role with only the Recurring Billing right assigned, or a role with only Batch Management and Reporting rights assigned).
Multiple roles or a single role assigned to a user.
The use of custom roles can be as simple as creating a few functional specific roles to use in tandem with the default system roles, or can be a replacement user role structure that is customized to fit your organizational business needs. This guide will show you how to create and manage custom roles as it applies to the four available user types within MyBridgePay, but it should be noted that this is an optional feature only and is not required to use MyBridgePay.
Default Systems Roles
There are four default system roles in MyBridgePay, one for each available user type. The default system roles are listed below.
Reseller - assigned to the Reseller user type
Sales Agent - assigned to the Sales Agent user type
Merchant Group - assigned to the Merchant Group user type
Merchant Account - assigned to the Merchant Account user type
Each default system role has a list of ‘rights’ (i.e. permissions) applied to allow basic but broad-based functionality based on the assigned user types.
Default System Roles - Assigned Rights
Reseller
Virtual Terminal: Virtual Terminal Tab, Auth Only, Sale, Refund, Void, Repeat Sale, Refund (Blind), Service Fee Override
Batch Management Tab
Reporting Tab
Merchant Boarding: Boarding Tab, Merchant Account (Add, Edit, Activate/Deactivate), Merchant Group (Add, Edit, Activate/Deactivate), User (Add, Edit, Activate/Deactivate), Processing Applications (View, Configure, Activate/Deactivate), Sales Agent (Add, Edit, Activate/Deactivate)
Administration: Role (Add, Delete, Edit), Change other user's password, Admin Tab
Processors (access to the full list of processors available on MyBridgePay - more on this list of rights later)
Recurring Billing Tab
Sales Agent
Virtual Terminal: Virtual Terminal Tab, Auth Only, Sale, Refund, Void, Repeat Sale, Refund (Blind), Service Fee Override
Batch Management Tab
Reporting Tab
Merchant Boarding: Boarding Tab, Merchant Account (Add, Edit, Activate/Deactivate), Merchant Group (Add, Edit, Activate/Deactivate), User (Add, Edit, Activate/Deactivate), Processing Applications (View, Configure, Activate/Deactivate)
Administration: Role (Add, Delete, Edit), Change other user's password, Admin Tab
Processors (access to the full list of processors available on MyBridgePay - more on this list of rights later)
Recurring Billing Tab
Merchant Group
Virtual Terminal: Virtual Terminal Tab, Auth Only, Sale, Refund, Void, Repeat Sale, Refund (Blind)
Batch Management Tab
Reporting Tab
Merchant Boarding: Boarding Tab, Merchant Account (Edit) User (Add, Edit, Activate/Deactivate)
Administration: Change other user's password, Admin Tab
Recurring Billing Tab
Merchant Account
Virtual Terminal: Virtual Terminal Tab, Auth Only, Sale, Refund, Void, Repeat Sale, Refund (Blind), Adjustment
Batch Management Tab
Reporting Tab
Recurring Billing Tab
Assigning Rights to Custom Roles Explained
When creating custom roles as a Reseller or Sales Agent for your direct hierarchy, you’ll assign a group of “rights” or a singular “right” to a role. This is effectively creating a list of end-user permissions that determine what functionality a user will be able to perform in MyBridgePay.
Reseller – Can create and manage additional Reseller users on their Reseller account; can also create and manage:
Sales Agent accounts and Sales Agent users
Merchant Group accounts and Merchant Group users (both under their Reseller and Sales Agent hierarchies)
Merchant Account accounts and Merchant Account users (both under their Reseller and Sales Agent hierarchies)
Sales Agent – Can create and manage additional Sales Agent users on their Sales Agent account; can also create and manage:
Merchant Group accounts and Merchant Group users (only under their Sales Agent hierarchy)
Merchant Account accounts and Merchant Account users (only under their Sales Agent hierarchy
List of Rights that can be assigned to Custom Roles
Reseller and Sales Agent users can create and manage custom roles assigned to the different user types available within their hierarchy structure. The rights that are assignable by user type are listed below.
Please note that while all rights display as selectable options when creating custom roles for all user types, not all rights will function on all user types. The permission rights mapping below provides a list of rights that will functionally work with the specified user type.
Reseller - permission rights options available for the Reseller user type
Module / Function | Permission Rights | Definition |
---|---|---|
Virtual Terminal | Auth Only | Credit card authorization transaction |
| Sale | Credit card and ACH sale transactions |
| Refund | Credit card refund on settled transaction |
| Void | If enabled on a user, will allow voiding payments in the Find Transactions module. |
| Repeat Sale | Credit card authorization and sale transactions |
| Virtual Terminal Tab | Displays the Virtual Terminal payment form |
| Refund (Blind) | Credit card and ACH refund without using a previously processed sale transaction (requires additional configuration setting enabled on a Merchant Account) |
| Cash-Sale | Cash and Check (paper) sale transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Check-Sale right) |
| Cash-Refund | Cash and Check (paper) refund transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Check-Refund right) |
| Check-Sale | Cash and Check (paper) sale transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Cash-Sale right) |
| Check-Refund | Cash and Check (paper) refund transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Cash-Refund right) |
| Refund-Sale | Credit card and ACH refund of a Sale transaction |
| Refund-Auth | Credit card refund of an authorization transaction |
| Service Fee Override | Ability to change or remove service fee amount and convenience fee amount on payment form. |
Batch Management | Batch Management Tab | Displays the Batch Management module and allows full access to manage and settle open batches, and review settled batch information. |
| Unsettled Transaction Void | If enabled on a user, will allow voiding payments on the Batch Management Unsettled Batch tab. |
Reporting | Reporting Tab | Displays the Reporting module and allows full access to execute, display, and export all reports. |
Merchant Boarding | Boarding Tab | Displays the Account Management module |
| Merchant Account | Displays the merchant account organization level for administration purposes |
| Add | Add a merchant account |
| Activate/Deactivate | Activate and Deactivate merchant accounts |
| Edit | Make changes to a merchant account |
| Merchant Group | Displays the merchant group organization level for administration purposes |
| Add | Add a merchant group |
| Edit | Make changes to a merchant group |
| Activate/Deactivate | Activate and Deactivate merchant groups |
| User |
|
| Add | Add a user (can only add users to organizations for which you have access) |
| Edit | Make changes to a user (can only make update to users on organizations for which you have access) |
| Activate/Deactivate | Activate and Deactivate users (can only activate and deactivate users on organizations for which you have access) |
| Processing Applications |
|
| View | View the Processing Applications tab |
| Configure | Make changes to a configuration setting on the Processing Applications tab |
| Activate/Deactivate | Activate and Deactivate configuration settings on the Processing Applications tab |
| Sales Agent | Displays the sales agent organization level for administration purposes |
| Add | Add a sales agent |
| Activate/Deactivate | Activate and Deactivate a sales agent |
| Edit | Make changes to a sales agent |
Administration | Role - Add | Ability to create a custom role |
| Role - Delete | Ability to delete a custom role |
| Role - Edit | Ability to make changes to a custom role. This includes changing the user type, adding role grading, or changing permission rights. |
| Admin tab | Displays the Admin module and allows users to create, edit, and delete custom roles. |
Processors | Processors Tab | Displays the Processors list that can be enabled as a select option for the Processors tab in Account Management to configure a Merchant Account. Ex: Enable TSYS as a processor on a Reseller or Sales Agent custom role, and only TSYS will appear as a processor option. |
Recurring Billing | Recurring Billing Tab | Displays the Recurring Billing module and allows full access to create/manage customers and wallets, contracts, contact templates, billing frequency templates, and processing transactions via the Recurring Billing Virtual Terminal payment form. |
Custom Fields | Transaction Custom Fields |
|
| View | Ability to view the Custom Fields Template in Account Management. |
| Add | Ability to create new custom fields. |
| Edit | Ability to make changes to existing custom fields. |
| Activate/Deactivate | Ability to activate and deactivate custom fields from the Custom Fields Template. |
| Activate Custom Fields |
|
| Configure | Ability to mass activate custom fields via the Boarding API only. |
| Deactivate Custom Fields |
|
| Configure | Ability to mass activate custom fields via the Boarding API only. |
Sales Agent - permission rights options available for the Sales Agent user type
Module / Function | Permission Rights | Definition |
---|---|---|
Virtual Terminal | Auth Only | Credit card authorization transaction |
| Sale | Credit card and ACH sale transactions |
| Refund | Credit card refund on settled transaction |
| Void | If enabled on a user, will allow voiding payments in the Find Transactions module. |
| Repeat Sale | Credit card authorization and sale transactions |
| Virtual Terminal Tab | Displays the Virtual Terminal payment form |
| Refund (Blind) | Credit card and ACH refund without using a previously processed sale transaction (requires additional configuration setting enabled on a Merchant Account) |
| Cash-Sale | Cash and Check (paper) sale transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Check-Sale right) |
| Cash-Refund | Cash and Check (paper) refund transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Check-Refund right) |
| Check-Sale | Cash and Check (paper) sale transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Cash-Sale right) |
| Check-Refund | Cash and Check (paper) refund transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Cash-Refund right) |
| Refund-Sale | Credit card and ACH refund of a Sale transaction |
| Refund-Auth | Credit card refund of an authorization transaction |
| Service Fee Override | Ability to change or remove service fee amount and convenience fee amount on payment form. |
Batch Management | Batch Management Tab | Displays the Batch Management module and allows full access to manage and settle open batches, and review settled batch information. |
| Unsettled Transaction Void | If enabled on a user, will allow voiding payments on the Batch Management Unsettled Batch tab. |
Reporting | Reporting Tab | Displays the Reporting module and allows full access to execute, display, and export all reports. |
Merchant Boarding | Boarding Tab | Displays the Account Management module |
| Merchant Account | Displays the merchant account organization level for administration purposes |
| Add | Add a merchant account |
| Activate/Deactivate | Activate and Deactivate merchant accounts |
| Edit | Make changes to a merchant account |
| Merchant Group | Displays the merchant group organization level for administration purposes |
| Add | Add a merchant group |
| Edit | Make changes to a merchant group |
| Activate/Deactivate | Activate and Deactivate merchant groups |
| User |
|
| Add | Add a user (can only add users to organizations for which you have access) |
| Edit | Make changes to a user (can only make update to users on organizations for which you have access) |
| Activate/Deactivate | Activate and Deactivate users (can only activate and deactivate users on organizations for which you have access) |
| Processing Applications |
|
| View | View the Processing Applications tab |
| Configure | Make changes to a configuration setting on the Processing Applications tab |
| Activate/Deactivate | Activate and Deactivate configuration settings on the Processing Applications tab |
Administration | Role - Add | Ability to create a custom role |
| Role - Delete | Ability to delete a custom role |
| Role - Edit | Ability to make changes to a custom role. This includes changing the user type, adding role grading, or changing permission rights. |
| Admin tab | Displays the Admin module and allows users to create, edit, and delete custom roles. |
Processors | Processors Tab | Displays the Processors list that can be enabled as a select option for the Processors tab in Account Management to configure a Merchant Account. Ex: Enable TSYS as a processor on a Reseller or Sales Agent custom role, and only TSYS will appear as a processor option. |
Recurring Billing | Recurring Billing Tab | Displays the Recurring Billing module and allows full access to create/manage customers and wallets, contracts, contact templates, billing frequency templates, and processing transactions via the Recurring Billing Virtual Terminal payment form. |
Custom Fields | Transaction Custom Fields |
|
| View | Ability to view the Custom Fields Template in Account Management. |
| Add | Ability to create new custom fields. |
| Edit | Ability to make changes to existing custom fields. |
| Activate/Deactivate | Ability to activate and deactivate custom fields from the Custom Fields Template. |
| Activate Custom Fields |
|
| Configure | Ability to mass activate custom fields via the Boarding API only. |
| Deactivate Custom Fields |
|
| Configure | Ability to mass activate custom fields via the Boarding API only. |
Merchant Group - permission rights options available for the Merchant Group user type
Module / Function | Permission Rights | Definition |
---|---|---|
Virtual Terminal | Auth Only | Credit card authorization transaction |
| Sale | Credit card and ACH sale transactions |
| Refund | Credit card refund on settled transaction |
| Void | If enabled on a user, will allow voiding payments in the Find Transactions module. |
| Repeat Sale | Credit card authorization and sale transactions |
| Virtual Terminal Tab | Displays the Virtual Terminal payment form |
| Refund (Blind) | Credit card and ACH refund without using a previously processed sale transaction (requires additional configuration setting enabled on a Merchant Account) |
| Cash-Sale | Cash and Check (paper) sale transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Check-Sale right) |
| Cash-Refund | Cash and Check (paper) refund transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Check-Refund right) |
| Check-Sale | Cash and Check (paper) sale transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Cash-Sale right) |
| Check-Refund | Cash and Check (paper) refund transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Cash-Refund right) |
| Refund-Sale | Credit card and ACH refund of a Sale transaction |
| Refund-Auth | Credit card refund of an authorization transaction |
| Service Fee Override | Ability to change or remove service fee amount and convenience fee amount on payment form. |
Batch Management | Batch Management Tab | Displays the Batch Management module and allows full access to manage and settle open batches, and review settled batch information. |
| Unsettled Transaction Void | If enabled on a user, will allow voiding payments on the Batch Management Unsettled Batch tab. |
Reporting | Reporting Tab | Displays the Reporting module and allows full access to execute, display, and export all reports. |
Merchant Boarding | Boarding Tab | Displays the Account Management module |
| Merchant Account | Displays the merchant account organization level for administration purposes |
| Edit | Make changes to a merchant account (does not allow editing of the organization account, but is required to edit merchant account users by the merchant group user type) |
| User |
|
| Add | Add a user (can only add users to organizations for which you have access) |
| Edit | Make changes to a user (can only make update to users on organizations for which you have access) |
| Activate/Deactivate | Activate and Deactivate users (can only activate and deactivate users on organizations for which you have access) |
Recurring Billing | Recurring Billing Tab | Displays the Recurring Billing module and allows full access to create/manage customers and wallets, contracts, contact templates, billing frequency templates, and processing transactions via the Recurring Billing Virtual Terminal payment form. |
Custom Fields | Transaction Custom Fields |
|
| View | Ability to view the Custom Fields Template in Account Management. |
| Add | Ability to create new custom fields. |
| Edit | Ability to make changes to existing custom fields. |
| Activate/Deactivate | Ability to activate and deactivate custom fields from the Custom Fields Template. |
| Activate Custom Fields |
|
| Configure | Ability to mass activate custom fields via the Boarding API only. |
| Deactivate Custom Fields |
|
| Configure | Ability to mass activate custom fields via the Boarding API only. |
Merchant Account - permission rights options available for the Merchant Account user type
Module / Function | Permission Rights | Definition |
---|---|---|
Virtual Terminal | Auth Only | Credit card authorization transaction |
| Sale | Credit card and ACH sale transactions |
| Refund | Credit card refund on settled transaction |
| Void | If enabled on a user, will allow voiding payments in the Find Transactions module. |
| Repeat Sale | Credit card authorization and sale transactions |
| Virtual Terminal Tab | Displays the Virtual Terminal payment form |
| Refund (Blind) | Credit card and ACH refund without using a previously processed sale transaction (requires additional configuration setting enabled on a Merchant Account) |
| Cash-Sale | Cash and Check (paper) sale transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Check-Sale right) |
| Cash-Refund | Cash and Check (paper) refund transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Check-Refund right) |
| Check-Sale | Cash and Check (paper) sale transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Cash-Sale right) |
| Check-Refund | Cash and Check (paper) refund transactions; (note these transactions appear on transaction reports only and are for informational purposes. They do not settle as part of a daily batch. – interchangeable with Cash-Refund right) |
| Refund-Sale | Credit card and ACH refund of a Sale transaction |
| Refund-Auth | Credit card refund of an authorization transaction |
| Service Fee Override | Ability to change or remove service fee amount and convenience fee amount on payment form. |
Batch Management | Batch Management Tab | Displays the Batch Management module and allows full access to manage and settle open batches, and review settled batch information. |
| Unsettled Transaction Void | If enabled on a user, will allow voiding payments on the Batch Management Unsettled Batch tab. |
Reporting | Reporting Tab | Displays the Reporting module and allows full access to execute, display, and export all reports. |
Recurring Billing | Recurring Billing Tab | Displays the Recurring Billing module and allows full access to create/manage customers and wallets, contracts, contact templates, billing frequency templates, and processing transactions via the Recurring Billing Virtual Terminal payment form. |
Processors
BridgePay has a variety of processor options available, however not all of those listed on the custom roles rights/permissions settings are currently certified. The list below is comprised of the processors that are certified and available for merchant processing. A custom role can be created for Reseller and Sales Agent users to limit the processor options list display when adding processors to a merchant account.
The list of active certified processors available on BridgePay Gateway is listed below.
Processor | Payment Method |
---|---|
GETI (PAYA) | ACH |
Eft T-TECH | ACH |
First data Omaha | Credit/Debit |
TSYS | Credit/Debit |
Vantiv Tandem | Credit/Debit |
First Data Rapid Connect | Credit/Debit |
Heartland Portico | Credit/Debit |
Elavon ViaConex4 | Credit/Debit |
SVS | Gift Card |
SPK (Sparkbase / Factor 4) | Gift Card |
TenderCard | Gift Card |
Profit Stars | ACH |
Optional Role Grading for Merchant group Custom Roles
Feature which allows optional security role grading to be applied to custom roles created by Resellers and Sales Agents for the “Merchant Group User” type. Role grading allows the Merchant Group user’s custom role to have a user security grading setting that ranks the role from 1 (highest access) to 99 (lowest access).Merchant Group users assigned a custom role may only create and manage roles of other merchant group users with the same grade ranking or lower. Multiple custom roles can be created with the same role grading number.Role graded custom roles can exist in combination with non-graded custom roles, but is not recommended.To enable the role grading security feature to function on applicable role graded custom roles for Merchant Group users, the “Use Role Grading” button must be enabled on the Merchant Group account.Please Note: If role-graded custom roles are being used in combination with non-graded custom roles, the non-graded custom roles will be applicable to all merchant group users regardless of any graded custom roles assigned to the user.Example of usage:If two custom roles are created and assigned a role-grade:
Merchant Group Admin – 1
Merchant Group Supervisor – 2
A user assigned the Merchant Group Supervisor role will not be able to assign, create, edit, activate, or deactivate users with the Merchant Group Admin custom role.
Hide System Roles Feature for Merchant Groups and Merchant Accounts
Feature which allows the default system roles to be hidden from the Roles select list when creating and managing Merchant Group and Merchant Account users. When enabled, only the custom roles created by Resellers and Sales Agents will be displayed and available for selection.The setting is located on the Business Info form.
- 1 Introduction
- 2 User Types
- 3 Default Systems Roles
- 4 List of Rights that can be assigned to Custom Roles
- 4.1 Reseller - permission rights options available for the Reseller user type
- 4.2 Sales Agent - permission rights options available for the Sales Agent user type
- 4.3 Merchant Group - permission rights options available for the Merchant Group user type
- 4.4 Merchant Account - permission rights options available for the Merchant Account user type
- 5 Processors
- 6 Optional Role Grading for Merchant group Custom Roles
- 7 Hide System Roles Feature for Merchant Groups and Merchant Accounts
Property of BridgePay Network Solution ©2024