Entity Custom Fields

Entity Custom Fields provide a powerful way to tailor how you manage custom data for Merchant entities. This feature incorporates specific data requested for risk reviews, enhancing the risk management process. Create and access custom fields through the Payrix Pro Portalto ensure seamless risk and external data integration.

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 this process 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.
Fee Rule Customization: Apply specific fee structures based on custom field values (e.g., "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.

Use Entity Custom Fields to ensure your software works seamlessly, driving increased boarding rates.

Get Started

To create Entity Custom Fields, you must provide the following information for each new custom field:

Field: The name of the actual field. This can be between 1 and 500 characters.
Label: The label the Merchant sees for the field while signing up. This can be between 1 and 500 characters.
Required: A yes or no dropdown making the custom field mandatory or not for completing signup.
Default: If you have a default value you’d like to have prefilled for this field, add it here.

Field Naming Best Practices

Entity Custom Fields is the process of creating your own parameter and value, like the standard key: value pair used by most coding languages to help identify each unique field and each field's unique value. Follow these industry best practices to ensure all members of your team can easily find, identify, and duplicate the field as needed for each entity:

Use Simplicity: Avoid unnecessary complexity and be descriptive with your name.
Set Field Formats: Choose one format: camel case (yourField), snake case (your_field), or kebab case (your-field). We recommend camel case.
Be Consistent: Use the same naming convention from your CRM or other system for your Keys where applicable for easy visibility.
Use Full Words: To avoid ambiguity among developers, use full words for names (for example, qty should be quantity).
Use Verb Language for Booleans: For Keys that accept a Boolean value (yes|1/no|0), use verb prefixes (such as hasAccess or isVIP).

Notes
Each custom field must be manually set because we do not provide a dropdown menu of previously added custom fields or an auto-complete feature.
You must match your custom field exactly to ensure your Risk policies, decisions, and fee rules will apply to that entity.

Assign Entity Custom Fields

After deciding which Entity Custom Fields you’d like to add, begin assigning them to individual Merchants. Because no dropdown menus, duplication function, auto-complete options, or predefined lists are available to select previously created Entity Custom Fields, you must adhere precisely to your Key naming conventions. This precision is vital to prevent any complications concerning fee application, Risk policies or decisions configured around this new field.

Send Custom Fields with New Merchants During Signup

To assign custom fields to your Merchant Signup Form and assign these values to Merchants as they sign up, submit an Implementation Services ticket with Fields, Label, Required, and Default values provided.

After the Implementation Team has successfully added your new Entity Custom Fields, each new Merchant that signs up is shown the new custom field during the signup form.

Assign New Custom Fields to Existing Merchants

Use the following steps to set up and assign new Entity Custom Fields for existing Merchants in the portal:

Select Merchants in the left navigation panel.
Select the desired Merchant to go to the Merchant Profile page.
Go to the Business menu from the left Merchant Profile menu.
Scroll down to the Custom Fields section.
Click Add Custom Field to open the Add Custom Field dialog.
Set the Field name and the Value you want to assign.
Click Add to finish creating the new Entity Custom Field.

Result: The existing Merchant receives a new entity custom field for storing unique values and can now be applied for Fee configurations or Risk Policies and Decisions.

Use Case: Trigger Risk Policies with Entity Custom Fields

Use Entity Custom Fields with Risk Decisions or Policies to enhance risk management automations. This integration provides entity-specific data insights and improves boarding rates by aligning compliance-related information with your risk practices.

The following section demonstrates how to use your new Entity Custom Field as the rule condition for a policy or decision. For more detailed setup steps and all information available, visit Using the Risk Management Page.

Set Up Entity Custom Fields to Trigger Risk Policies

To simplify the setup step, only the high-level action items are included here. For more details about every parameter and the functionality of Risk Policies, visit Understanding Policies - Risk.

Select Policies from the Risk dropdown in the left navigation panel.
Click Add Policy to create a new policy.
Define the Name, Stage, Target, and Status components.
Select the new policy from the Table to Add decisions.
Select the primary Decision from the list available, then click Next.
For Select a Sub-Decision, select ENTITY_CUSTOM from the dropdown.
Enter your custom field name into the dialog and set your Value.
Set your Operator & Action, then click Next.
Add any Rules, Dependencies and Failover Dependencies,
Click Create to complete the process.

Result: Your Risk policy is now configured to use your Entity Custom Field as an additional criteria to trigger the Risk.