For the complete documentation index, see llms.txt. This page is also available as Markdown.

Designing your tenant for CMP

Understanding Tenants

Tenants in the Credential Management Platform serve as distinct, logical units for managing card services and credentials. Think of them as containers that isolate and organize your card-related activities. In the past, the term 'Tenant' has been used interchangeably with 'Account.'

Purpose

Tenants enable you to segment and manage different sets of cards and services. They also allow for separate enrollments with third parties such as VISA, Mastercard, American Express, and Discover in the situation that the third party requires separate enrollments into services per-merchant.

For merchant aggregators such as Payment Service Providers (PSPs), PayFacs, and Marketplaces, this allows for clear separation of merchant data, where each merchant can have its own dedicated tenant.

Key Characteristics

  • Each tenant is uniquely identified by a Tenant ID (an identifier always beginning with prefix tnt).

  • Cards created within a tenant are exclusive to that tenant.

  • Service configurations and settings are applied at the tenant level.

Tenant Configuration Options

The platform offers flexible service configuration options at both the tenant and network levels:

Tenant-Level Service Control

  • You have the ability to enable or disable services for the entire tenant.

  • This provides a global setting for all cards related to the tenant.

Service
Overall Service Configuration

Enabled/Disabled

Enabled/Disabled

Enabled/Disabled

Enabled/Disabled

Disabled by default. For upgrade, please contact support via support@vgs.io

Enabled/Disabled

Enabled/Disabled

Network-Level Service Control

You can further refine service settings by enabling or disabling services at the network level (e.g., Visa, Mastercard). This allows for granular control over service availability based on the card network. Both Account Updater and Network Token services can be individually enabled or disabled per network, based on your business requirements.

Service
Network-Level Configuration

Enabled/Disabled

Enabled/Disabled

Enrollment Types

The platform supports two enrollment types, determining how services are activated:

On-Create Enrollment

  • This is the default setting.

  • When a card object is created, the system automatically processes and activates the services enabled for the tenant.

  • A webhook notification is sent upon successful service activation.

Manual Enrollment

  • With manual enrollment, card creation does not automatically trigger service activation.

  • You must explicitly invoke individual service endpoints to perform actions like network tokenization or account updater participation.

  • This provides greater control over the timing of service activation.

Service
Enrollment Type

On Create Card (Default)/Manual

On Create Card (Default)/Manual

Last updated