User Roles

Roles are used to determine how much access a user has to see, edit, create, or delete information on the portal. Roles can be assigned to users to provide or extract the access capabilities they're intended to have.

Each user has a set of default Roles, and customizable parameters allowing you to restrict or allow access to specific pages and functions of the Portal.

Role Resources

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

Default Roles

Default Roles determine the level of Portal access for a user. Referrer-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-Level Default Roles
Facilitator Full Access	This level of access allows a user to view and edit/manage all Referrers & Merchants underneath the Facilitator entity account.
Facilitator View Only	This level of access allows a user to view only all Referrers & Merchants underneath the Facilitator entity account.

Referrer-Level Default Roles

Referrer-Level Default Roles
Referrer Admin Full Access	This level of access allows a user to view and edit/manage all Merchants underneath a Referrer hierarchy in addition to managing sub-Referrer accounts underneath their Division.
Referrer Admin View Only	This level of access allows a user to view only all Merchants underneath a Referrer hierarchy in addition to viewing any sub-Referrer accounts underneath their Division.
Referrer Full Access	This level of access allows a user to view and edit/manage all Merchants underneath the Referrer account.
Referrer View Only	This level of access allows a user to view only all Merchants underneath the Referrer account.

Merchant-Level Default Roles

Merchant-Level Default Roles
Merchant Admin Full Access	This level of access allows a user to view and edit/manage the Merchant account(s) 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) 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 Roles

Custom Roles provide five Role categories which contain fifteen Role resources:

Custom Role Categories

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.

Custom Role Resources

The Custom Role Resources allow the user’s access to be refined by specific resources or actions on the platform. See the available Custom Role Resources below:

Bank Accounts

The Bank Accounts role resource allows the user to add bank accounts for payouts or debits to an entity, such as a Referrer or Merchant.

This role resource is available in all role categories (Create, Full View, Summary View, Update, & Delete)

There are two available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
accounts	Access to view the bank account(s) associated with an entity.	Full View Summary View
accountVerifications	Access to view attempts to verify ownership of a bank account through deposit verification or credentials.	Full View Summary View

Recurring Payments

The Recurring Payments role resource allows the user to set up recurring payments/subscriptions for a Merchant.

This role resource is available in all role categories (Create, Full View, Summary View, Update, & Delete).

There are five available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
plans	Access to create, view, and edit recurring payment plans: Payment Amount Merchant Payment Schedule Payment Status	Create Full View Summary View Update Delete
subscriptions	Access to view and edit existing recurring payment plans (subscriptions).	Create Full View Summary View Update Delete
subscriptionTokens	Access to create, view, and edit credit card tokens used for the recurring payment plan.	Create Full View Summary View Update Delete
tokens	Access to create, view, and edit recurring payment plan token details represented in the Token ID: Expiration Date Last 4 Digits of Credit Card CVV	Create Full View Summary View Update Delete
customers	Access to create, view, and edit customer data records associated with a recurring payment plan.	Create Full View Summary View Update Delete

Merchant

The Merchant role resource allows the user to set up, view, and edit Merchants under a Referrer.

This role resource is available in all role categories (Create, Full View, Summary View, Update, & Delete).

There are ten available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
entities	Access to setup, view, and edit the top-level API resource of a business: Merchant Referrer Payment Facilitator	Create Full View Summary View Update Delete
merchants	Access to set, view, and update a Merchant that collects money from their clients via transaction processing.	Full View Summary View Update
members	Access to create, view, and edit a member’s (person) data associated with a Merchant. One member associated with each Merchant will be the “primary” member that has the most ownership share for that Merchant.	Create Full View Summary View Update Delete
contacts	Access to create, view, and edit a person's data records associated with an entity.	Create Full View Summary View Update Delete
terminals	Access to create, view, and edit the information for the device/software used to process transactions.	Create Full View Summary View Update Delete
funds	Access to view the amount of money for a specific entity including: pending balance, available balance, total balance, and; any funds that are in reserve.	Full View Summary View
fundOrigins	Access to view the source of where funds were processed for an entity.	Full View Summary View
entries	Access to view the movement of funds from an entity.	Full View Summary View
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).	Full View Summary View
entryOrigins	Access to view the origin of an entry (such as a transaction and where it was funded).	Full View Summary View

Groups

The Groups role resource allows the user to group Merchants together to set up specific rules for risk management and fees, as well as enable specific parameters.

This role resource is available in all role categories (Create, Full View, Summary View, Update, & Delete)

There are two available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
orgs	Access to create, view, and edit the collection of entities within a group.	Create Full View Summary View Update Delete
orgEntities	Access to create, view, and edit the relationship between an org (group) and a specific entity.	Create Full View Summary View Update Delete

Withdrawal Schedules

The Withdrawal Schedule role resource allows the user to set a withdrawal/payout for an entity to disburse funds or collect funds from the associated account.

This role resource is available in all role categories (Create, Full View, Summary View, Update, & Delete)

There are no available sub-resources 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, & Delete).

There are six available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
txns	Access to create, view, and edit a payment used to charge a Merchant’s customer. Such as: Credit Card, eCheck, or; Payment Token	Create Full View Summary View
txnResults	Access to view the details of a specific transaction, including: type of transaction, and; any associated decline and validation message with CVV and AVS.	Full View
batches	Access to create, view, and update a group of transactions sent to the processor for settlement.	Create Full View Summary View
entityReturns	Access to view ACH transactions that have been rejected.	Full View
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.	Create Full View Summary View
txnDatas	Access to view the base64 image of a signature when creating a transaction and save within the `txnDatas` endpoint.	Full View

Risk Management

The Risk Management role resource allows the user to manage Merchant/transaction risk factors that are open, reviewed, approved, or blocked.

This role resource is available in all role categories (Create, Full View, Summary View, Update, & Delete).

There are four available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
holds	Access to create and view a reviewable action taken on a transaction.	Create Full View
notes	Access to create, view, update, and delete risk management notes regarding why a transaction or Merchant was reviewed and (if applicable) released.	Create Full View Update Delete
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.	Create Full View Update Delete
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.	Create Full View Update Delete

Alerts

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, & Delete).

There are three available sub-resources for this role resource:

Resource	Description	Role Categories

Resource

Description

Role Categories

alerts

Access to create, view, update, and delete a specific event notification.

Create
Full View
Summary View
Update
Delete

alertActions

Access to create, view, update, and delete the action taken on an alert event such as:

sending an email or;
using a webhook notification.

Create
Full View
Summary View
Update
Delete

alertTriggers

The triggering event that causes an alert to be sent such as a transaction failing or a payout being disbursed.

Create
Full View
Summary View
Update
Delete

Track Pending Merchants

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 sub-resources 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, & Delete).

There are nine available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
logins	Access to create, view, update, and delete a user associated with a specific login including: username, password, email, first/last name, address, and; association with a partition & division.	Create Full View Summary View Update Delete
apiKeys	Access to create, view, update, and delete a permanent method of authentication to the API.	Create Full View Summary View Update Delete
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.	Create Full View Summary View Update Delete
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.	Create Full View Summary View Update Delete
messageThreads	Access to create, view, update, and delete the sender, receiver, and subject of a message resource.	Create Full View Summary View Update Delete
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.	Create Full View Summary View Update Delete
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.	Create Full View Summary View Update Delete
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.	Create Full View Summary View Update Delete
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.	Create Full View Summary View Update Delete

Disputes

The Disputes role resource allows the user to manage disputes (chargebacks) that are open, closed, won, or lost.

This role resource is available in all role categories (Create, Full View, Summary View, Update, & Delete).

There are five available sub-resources for this role resource:

Resource	Description	Role Categories

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.	Summary View
chargebackDocuments	Access to create and view the message sent by a Merchant, processor, or bank about a chargeback.	Create Full View Summary View
chargebackMessages	Access to view the status of a chargeback such as if it is in Retrieval, Arbitration, Lost, or Won.	Summary View
chargebackStatuses	Access to view the result of a message associated with a chargeback.	Summary View
chargebackMessageResults	Access to create and view any file related to a chargeback.	Create Full View Summary View Update Delete

Invoices

The Invoices role resource allows the user to manage invoices sent to clients to collect money for a specific transaction or event.

This role resource is available in all role categories (Create, Full View, Summary View, Update, & Delete).

There are four available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
invoices	Access to create, view, and delete: invoices for customers, email an invoice, pay an invoice, and; track payments for a specific invoice.	Create Full View Summary View Delete
invoiceItems	Access to create, view, and delete the line item details specific to an invoice resource.	Create Full View Summary View Delete
invoiceLineItems	Access to create, view, and delete an invoice item by holding information such as quantity and pricing of each item.	Create Full View Summary View Delete
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.	Create Full View Summary View

Invoice Configuration

The Invoice Configuration role resource allows the user to configure how an invoice is created such as by providing a set address, message, token, or logo for an invoice.

This role resource is available in all role categories (Create, Full View, Summary View, Update, & Delete)

There are no available sub-resources 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 & Summary View).

There are three available sub-resources for this role resource:

Resource	Description	Role Categories

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.	Full View Summary View
disbursementResults	Access to view a specific disbursement result such as if it was successful or failed.	Full View Summary View
entityReturns	Access to view a disbursement that has been rejected.	Full View Summary View

Splits

The Splits role resource allows the user to split an entry between two entities.

This role resource is available in the Full View role category.

There are two available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
profitShareResults	Access to view an entity to have earnings/expenses shared with another entity.	Full View Summary View
adjustments	Access to view monetary adjustments made to an entity's funds.	Full View Summary View

Quick Charge

The Quick Charge role resource allows the user to view and use the Quick Charge section as found on the user's Payrix dashboard.

This role resource is available in the Full View role category.

There are three available sub-resources for this role resource:

Resource	Description	Role Categories

Resource	Description	Role Categories
quickCharge	Access to view and use the quick charge (virtual terminal) to process a transaction on a Merchant entity.	Full View
cc	Access to view and use the quick charge to process a credit card transaction.	Full View
eCheck	Access to view and use the quick charge to process an eCheck transaction.	Full View

Set Default User (Primary Access) Roles

Use the steps below to set a user's Default User Roles for primary access:

Step 1: From the Portal Dashboard menu, click Users (under the Management tab.)
Step 2: In the Users menu, click the Add User Button to reveal the Create a User lightbox.
Step 3: Select the desired Default Role from the Role drop-down. Then, set the Username, Password, Full Name, and Email Address and click the ADD USER button.

Set Custom User Roles

Use the steps below to set a user's Custom User Roles for additional refined user access. Start by following Steps 1-3 above.

Step 1: After being returned to the Users menu, click on the user you created to be redirected to that user’s User Profile menu.
Step 2: Select the Role tab from the User Profile Menu bar
Step 3: Click the “Select resources to allow” drop-down next to each desired Role Category
Step 4: Toggle the desired Role Resources checkboxes.
- (Select All to apply all Role Resources, or None to apply no Role Resources from the respective Role Category)
Step 5: To enable sub-resources of Role Resources, click the Advanced toggle switch in the upper right-hand corner of the window.
Step 6: Click the arrow next to the desired Role Category to reveal each category’s role resources.
Step 7: Clicking the arrow next to each Role Resource will reveal each resource’s sub-resource access options.
Step 8: Toggle each Role Sub-Resource you want to enable for the User.
Step 9: Click Save in the upper right-hand corner after selecting all desired Role Resources and Sub-Resources to enable and save the user’s access changes.