...
Role resources determine the specific abilities that a user will have when navigating the Portal. In many cases, the Default Roles available for Referrers and Merchant-level Users provide the necessary access capabilities that most Users need to perform daily actions such as creating Transactions or Withdrawals. For unique cases where Default Roles don’t satisfy the specific criteria required by the Parent Entity or Users, Custom Roles allow individual assignment of specific resources (see below) with sub-resources for a completely modular user setup.
Default Roles
Default Roles determine the level of Portal access for a user. Referrer-Level level Access Roles are roles available to users of a Referrer-level entity, while Merchant-Level Access Roles are available to users of a Merchant-level entity.
Note: The Referrer has the unique ability to create and manage ALL Merchants under a Referrer as well as manage Sub-Referrers. The Referrer also can log in to view the Merchant portal. The Merchant Access Roles only allow for the management of that respective Merchant and its sub-Merchants.
Facilitator-Level Default Roles | |
|---|---|
Facilitator Full Access | This level of access allows a user to view and edit/manage all Referrers & and Merchants underneath under the Facilitator entity account. |
Facilitator View Only | This level of access allows a user to view only all Referrers & and Merchants underneath under the Facilitator entity account. |
Referrer-Level Default Roles | |
|---|---|
Referrer Admin Full Access | This level of access allows a user to view and edit/manage all Merchants underneath a under a Referrer hierarchy in addition to managing sub-Referrer accounts underneath under their Division. |
Referrer Admin View Only | This level of access allows a user to view only all Merchants underneath under a Referrer hierarchy in addition to viewing any sub-Referrer accounts underneath under their Division. |
Referrer Full Access | This level of access allows a user to view and edit/manage all Merchants underneath under the Referrer account. |
Referrer View Only | This level of access allows a user to view only all Merchants underneath under the Referrer account. |
Merchant-Level Default Roles | |
|---|---|
Merchant Admin Full Access | This level of access allows a user to view and edit/manage the Merchant account(s) accounts they are associated with, in addition to managing sub-Merchant accounts. |
Merchant Admin View Only | This level of access allows a user to view the Merchant account they are associated with in addition to viewing sub-Merchant accounts. |
Merchant Full Access | This level of access allows a user to view and edit/manage the Merchant account(s) accounts they are associated with. |
Merchant View Only | This level of access allows a user to view only the Merchant account they are associated with. |
...
Custom Role Categories | |
|---|---|
Create | Gives Users access to create content from the allowed role resources. |
Full View | Gives Users access to view content from the allowed role resources. |
Summary View | Gives User access to view monetary totals from the allowed role resources. |
Update | Gives User access to update content from the allowed role resources |
Delete | Gives User access to delete content from the allowed role resources. |
...
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are two available Two sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
accounts | Access to view the bank account(s) accounts associated with an entity. |
|
accountVerifications | Access to view attempts to verify ownership of a bank account through deposit verification or credentials. |
|
...
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are five available Five sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
plans | Access to create, view, and edit recurring payment plans:
|
|
subscriptions | Access to view and edit existing recurring payment plans (subscriptions). |
|
subscriptionTokens | Access to create, view, and edit credit card tokens used for the recurring payment plan. |
|
tokens | Access to create, view, and edit recurring payment plan token details represented in the Token ID:
|
|
customers | Access to create, view, and edit customer data records associated with a recurring payment plan. |
|
...
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There Ten sub-resources are ten available sub-resources for this role resource:
Resource | Description | Role Categories |
|---|---|---|
entities | Access to setup, view, and edit the top-level API resource of a business:
|
|
merchants | Access to set, view, and update a Merchant that collects money from their clients via transaction processing. |
|
members | Access to create, view, and edit a member’s (person) data associated with a Merchant.
|
|
contacts | Access to create, view, and edit a person's data records associated with an entity. |
|
terminals | Access to create, view, and edit the information for the device/software used to process transactions. |
|
funds | Access to view the amount of money for a specific entity including:
|
|
fundOrigins | Access to view the source of where funds were processed for an entity. |
|
entries | Access to view the movement of funds from an entity. |
|
pendingEntries | Access to view an entry that will be created in the future (such as a refund that has been submitted reducing the available balance but has not been captured). |
|
entryOrigins | Access to view the origin of an entry (such as a transaction and where it was funded). |
|
...
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are two available Two sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
orgs | Access to create, view, and edit the collection of entities within a group. |
|
orgEntities | Access to create, view, and edit the relationship between an org (group) and a specific entity. |
|
...
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are no available No sub-resources are available for this role resource.
Payments
The Payments role resource allows the user to view transactions/payments.
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are six available Six sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
txns | Access to create, view, and edit a payment used to charge a Merchant’s customer. Such as, such as one of the following:
|
|
txnResults | Access to view the details of a specific transaction, including the following:
|
|
batches | Access to create, view, and update a group of transactions sent to the processor for settlement. |
|
entityReturns | Access to view ACH transactions that have been rejected. |
|
items | Access to create, view, and update a line item associated with a particular transaction that is used to describe the cost, quantity, and other item details. |
|
txnDatas | Access to view the base64 image of a signature when creating a transaction and save within the |
|
...
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are four available Four sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
holds | Access to create and view a reviewable action taken on a transaction. |
|
notes | Access to create, view, update, and delete risk management notes regarding why a transaction or Merchant was reviewed and (if applicable) released. |
|
decisions | Access to create, view, update, and delete create, view, update, and delete the schedule and rules for a transaction check such as validating AVS/CVV. |
|
decisionRules | Access to create, view, update, and delete the conditions that make a risk decision apply during a specific circumstance such as not allowing a transaction over a specific amount to process. |
|
...
The Alerts role resource allows the user to manage the particular event that invokes a notification sent to an end-user.
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are three available Three sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
alerts | Access to create, view, update, and delete a specific event notification. |
|
alertActions | Access to create, view, update, and delete the action taken on an alert event such as:
|
|
alertTriggers | The triggering event that causes an alert to be sent such as a transaction failing or a payout being disbursed. |
|
...
The Track Pending Merchants role resource allows the user to view the Request More Info page in the Portal as a Referrer.
There are no available No sub-resources are available for this role resource.
User Management
The User Management role resource allows the user to manage a specific user (login) associated with an entity.
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are nine available Nine sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
logins | Access to create, view, update, and delete a user associated with a specific login, including all of the following:
|
|
apiKeys | Access to create, view, update, and delete a permanent method of authentication to the API. |
|
iplists | Access to create, view, update, and delete the list of IP (Internet Protocol) addresses that are used to whitelist or deny for a specific login so only specific IP addresses can be used. |
|
messages | Access to create, view, update, and delete the message associated with a specific user such as if a transaction has been placed on hold. |
|
messageThreads | Access to create, view, update, and delete the sender, receiver, and subject of a message resource. |
|
teams | Access to create, view, update, and delete the collection of logins that are associated with a team to grant additional permissions such as access to multiple Merchants. |
|
teamLogins | Access to create, view, update, and delete the link between a Login and a Team in addition to the Login's rights such as View Only or Admin on the team. |
|
aggregations | Access to create, view, update, and delete the application of desired calculations such as a count, sum, min/mac to a given resource within a search query. |
|
mappings | Access to create, view, update (re-map), and delete fields in the API for either input or output such as if the system uses a different format for output data than what is sent to the API. |
|
...
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are five available Five sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
chargebacks | Access to view a chargeback filed on a transaction such as a duplicate charge or an item not being as described. |
|
chargebackDocuments | Access to create and view the message sent by a Merchant, processor, or bank about a chargeback. |
|
chargebackMessages | Access to view the status of a chargeback such as if it is in Retrieval, Arbitration, Lost, or Won. |
|
chargebackStatuses | Access to view the result of a message associated with a chargeback. |
|
chargebackMessageResults | Access to create and view any file related to a chargeback. |
|
...
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are four available Four sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
invoices | Access to create, view, and delete the following:
|
|
invoiceItems | Access to create, view, and delete the line item details specific to an invoice resource. |
|
invoiceLineItems | Access to create, view, and delete an invoice item by holding information such as quantity and pricing of each item. |
|
invoiceResults | Access to create and view the status of an invoice such as if it was successful or failed and additional details associated with a particular invoice. |
|
...
This role resource is available in all role categories (Create, Full View, Summary View, Update, & and Delete).
There are no available No sub-resources are available for this role resource.
Withdrawal History
The Withdrawal History role resource allows the user to view the history of disbursements that have been processed or failed for a specific entity.
This role resource is available in two role categories (Full View & and Summary View).
There are three available Three sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
splitsDisbursements | Access to view a breakdown of what was paid out to an entity account based on sales, fees, chargebacks, and returns. Etc. |
|
disbursementResults | Access to view a specific disbursement result such as if it was successful or failed. |
|
entityReturns | Access to view a disbursement that has been rejected. |
|
...
This role resource is available in the Full View role category.
There are two available Two sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
profitShareResults | Access to view an entity to have earnings/expenses shared with another entity. |
|
adjustments | Access to view monetary adjustments made to an entity's funds. |
|
...
This role resource is available in the Full View role category.
There are three available Three sub-resources are available for this role resource:
Resource | Description | Role Categories |
|---|---|---|
quickCharge | Access to view and use the quick charge (virtual terminal) to process a transaction on a Merchant entity. |
|
cc | Access to view and use the quick charge to process a credit card transaction. |
|
eCheck | Access to view and use the quick charge to process an eCheck transaction. |
|
...
Set Default User (Primary Access) Roles
Use Complete the following steps below to set a user's Default User Roles for primary access:
...
From the Portal Dashboard menu, click Users (under
...
Management
...
).
...
...
In the Users menu, click
...
Add User
...
to reveal the Create a User lightbox.
...
Select the desired Default Role from the Role
...
dropdown menu.Then, set the Username, Password, Full Name, and Email Address and click
...
ADD USER
...
.
Set Custom User Roles
Use the steps below After setting a user’s Default User Roles, complete the following steps to set a user's Custom User Roles for additional refined user access. Start by following Steps 1-3 above.
...
:
After being returned to the Users menu,
...
select the user you created to be redirected to that user’s User Profile menu.
...
Select the Role tab from the User Profile Menu bar.
...
Click the
...
Select resources to allow
...
dropdown menu next to each desired Role Category.
...
Toggle the desired Role Resources checkboxes.
...
Select All to apply all Role Resources
...
.
Select None to apply no Role Resources from the respective Role Category
...
.
...
To enable sub-resources of Role Resources, click the Advanced toggle
...
in the upper-right
...
corner of the window.
...
Click the arrow next to the desired Role Category to reveal each category’s role resources.
...
Click the arrow next to each Role Resource
...
to reveal each resource’s sub-resource access options.
...
Toggle each Role Sub-Resource you want to enable for the User.
...
Click Save in the upper-right
...
corner after selecting all desired Role Resources and Sub-Resources to enable and save the user’s access changes.