Skip to content

The Tenants Module

Directory of Tenants showing a table with ID, tenant brand name, CRM vendor, and last updated timestamp

A tenant — commonly referred to as a brand within the organisation — is an isolated business entity within Payment Nexus. Tenants relate to CRM vendors the same way PSPs relate to PSP vendors: each tenant can connect to a CRM platform through an adapter, and multiple tenants can share the same CRM vendor. Each tenant has its own branding, domain configuration, customer records, PSP assignments, client communication settings, API credentials, and outgoing webhooks. Data is strictly separated between tenants.

The Tenants module is where you manage the full lifecycle of these entities: creating new tenants, configuring their checkout experience, wiring up integrations, and monitoring their payments and customers.

Permissions

ActionPermission required
List tenantstenant:list
View a tenanttenant:read
Create a tenanttenant:create
Edit basic detailstenant:update:basic
Edit brandingtenant:update:branding
Edit payment channelstenant:update:channels
Edit domainstenant:update:domains
Edit CRM adaptertenant:update:adapter
Manage support settingstenant:update:support
Manage API credentialstenant:manage:api:credentials
Manage webhookstenant:manage:webhooks
View audit trailtenant:audit

Directory

The tenant directory is searchable, filterable, sortable, and exportable.

ColumnDescription
IDInternal tenant identifier
TenantBrand name and visual identity
CRM VendorThe CRM system integrated with this tenant, if any
Updated AtTimestamp of the most recent configuration change

Row actions

Each row has four pinned actions:

ActionDescription
ViewOpen the tenant detail page
EditEdit the tenant's name and description
Manage ChannelsJump directly to payment channel configuration
Manage BrandingJump directly to branding configuration

Creating a tenant

Click New in the toolbar to create a new tenant. This opens a full creation form covering basic details, branding, and initial configuration.