Overview of Entities

Prev Next

Understanding entities is crucial for enhancing portfolio management and streamlining operations, including merchant onboarding and payment facilitation services. Knowing various entity types and processes enables you to customize solutions with control over various capabilities. Fees, billing, automated risk decisions, white-label customization, onboarding workflows, and secure URL redirection hosting are some of the capabilities you can configure.

Note

Some terms will only apply at a facilitator level and do not apply to partners and below. To request updates to your Division, Host, or Workflow configuration as a Payrix Pro partner, submit an Implementation Services ticket.

Entity Types

These entity types represent the types of business entities that interact with the Payrix Pro platform either directly or through a white-labeled offering:

  • Facilitator: A payment facilitator (PayFac) offering products and capabilities of the Worldpay platform to their Payment Facilitation-as-a-Service partners, assuming all risk and underwriting liabilities as a payment facilitation business.

  • Partner: A Payrix Pro partner, offering merchants the products and capabilities available through the Payrix Pro platform as a white-labeled referral of Payment Facilitation-as-a-Service.

  • Merchant: A business successfully onboarded to the platform through a partner to accept payment transactions for products and services sold to customers.

Entity Hierarchy

To illustrate the complex relationships among facilitators, partners, and merchants, this flow diagram provides a clear and detailed representation of the entity hierarchy within the platform ecosystem:

Entity Management Terms

These are technical terms used by the Payrix Pro platform to describe logical groupings of various processes, entities, and their relevant portfolio data:

  • Partition: A representation of a facilitator’s portfolio on the Payrix Pro platform, housing all partners, merchants, and Users data, Host settings, and other platform-wide settings. Partitions can be further divided into Divisions, to create strategic separations for individual partner portfolios within.

  • Division: A representation of a partner’s portfolio contained within a Payrix Pro Partition or the Partition of another facilitator-level entity that contains all merchant and User data, Host settings, and Workflow configurations. These settings and configurations can be modified on an individual basis without affecting other Divisions or merchants under a Partition.

  • Host: A configuration of white-label branding configurations and platform-wide settings that can be applied at a Partition and Division level.

  • Group: A collection of partner or merchant entities with same configurations applied for fees, billing, risk decisions, withdrawal flows, and other parameters.

  • Workflow: An automated process configuration that assigns new merchants to an existing Group when they submit a completed Signup Form hosted under a Partition or Division.


         

Divisions

A Division represents a partner’s portfolio within the Payrix Pro platform. During implementation, a Division is created for you to house all merchant and user data, Host settings, and Workflows associated with your portfolio.

The following diagram illustrates the relationship between Divisions and merchant entities. The Implementations team can apply white-label configurations (through Host settings) and merchant onboarding automation (through Workflows) for your Division. These configurations facilitate the seamless onboarding of merchants under your white-labeled portfolio.

Note

To access certain features, such as downloading 1099-K forms directly from the portal, you must white label your Payrix Pro portal and API. These features are enabled under your white-label configurations, and they will be unavailable if you choose not to white label.

Groups

A Group is a collection of entities set up by a parent entity. The parent entity can configure fee settings, risk decisions, and other parameters that apply to all Group member entities. Groups can be configured from facilitators for partners, from partners for merchants, or from merchants for their sub-merchants.

Groups are useful because a parent entity can apply the same logic for various parameters and settings to multiple Group members at once. This saves a great deal of time and effort versus manually configuring each entity individually.

To step-by-step instructions on creating a Group and adding members to the Group, see Set Up a Group.

Note

The following describes the difference between Groups, Divisions, and Teams:

  • Group: A collection of entities where you can configure fees, risk decisions, and setup parameters that apply to all entities in the group. This is sometimes called an Org.

  • Division: This is where workflows are set up to automatically add merchants to groups when created, and also where the white label is configured.

  • Team: A collection of Payrix Pro users that share roles and similar user properties to access the portal or API.

Workflows

A Workflow represents a process configuration that automatically assigns new merchants to an existing Group when they submit a Signup Form hosted by a facilitator or partner. Workflows can be applied at a Partition (facilitator) and Division (partner) level.

Workflows are an easy way to automatically add merchants to Groups with pre-established fee and billing settings, automated risk decisions, withdrawal schedules, and more as they are onboarded. Alternatively, Workflows are also a great way to move high-risk merchants to a group that applies more aggressive fees to help offset chargebacks, refunds, and other losses associated with high-risk entity action.

Division Workflow configurations override Partition Workflow configurations. If no Division Workflow configuration is set up, the merchant offering will default to the Partition-level Workflow configuration.

Note

Only facilitators can enable Workflow configurations at any level.

  • For partners under the Payrix Pro Partition, submit an Implementations Services ticket to enable your unique Division Workflow.

  • For partners under another facilitator’s Partition, contact their implementation team with the preferred information below to have them create the Workflow on your behalf.

A Workflow consists of a Trigger and an Action. The Trigger is the event that initiates the Action to add or remove the specified merchant from the specified Groups.

Workflow Triggers

Workflow Triggers are the events that occur that initiate the automated Workflow Action. The following Triggers are available:

  • Create: When a new merchant account is created, but not fully boarded.

  • Low: When a new merchant account is reviewed and rated as a low-risk entity.

  • High: When a new merchant account is reviewed and rated as a high-risk entity.

  • Board: When a new merchant account has been approved and onboarded to the platform.

Workflow Actions

  • Add: Adds the merchant account to one or more designated Groups.

  • Remove: Removes the merchant account from one or more designated Groups.

Entity User Login Capabilities

Users from each entity can log in to their respective portal accounts and perform actions based on their roles and access granted through Teams. Higher-level entities can access the accounts and portal views for their boarded entities unless manually restricted. For example, a partner-level user can typically log into and view their merchants' accounts in the portal.

Note

In common scenarios where one merchant needs to log in to another merchant as a result of multiple locations under the same business, a multilocation merchant structure is required. See Multilocation Merchant Structure for more information about multilocation structure setups.

Entity Custom Fields

Entity Custom Fields provide a way to tailor how you manage custom data for merchant entities. This feature supports the collection of data requested for risk reviews, enhancing the risk management process. Using Entity Custom Fields also ensures your software integrates seamlessly, helping to increase onboarding rates.

With Entity Custom Fields, you can:

  • Streamline risk data requests: Provide MCC-specific information requested from the Payrix Pro Merchant Onboarding and Risk teams to streamline reviews and reduce wait times.

  • Store external identifiers: Link a merchant to an external CRM or ERP system using a unique ID.

  • Set custom risk flags: Add internal risk scores or flags that influence automated decision-making.

  • Customize fee rules: Apply specific fee structures based on custom field values, such as High Volume Merchant.

  • Set operational tags: Tag entities with operational metadata like Beta Tester, Seasonal, or VIP.

  • Collect merchant metadata: Capture data unique to a merchant’s workflow, such as sales rep ID, onboarding channel, or campaign source.

See Set Up Entity Custom Fields for instructions on creating and using custom fields.