Estate management

The Business Object Model (BOM) APIs provide organization administrators with the ability to manage the logical structure of the platform's payment estate.

Key capabilities include:

• Create and manage:
  • Merchants
  • Stores
  • Points of Interaction (POIs) (i.e. payment terminals / COTS devices)
• Build and maintain the merchant → store → device hierarchy: ie. assign, manage, add and remove terminals to merchant and stores

Hierarchy Model

The BOM model enforces a strict hierarchy:

• The root object is the Organization.
  • Organization and its Contracts are created by switstack administrators.
  • Organization admins can update metadata for their own Organization.
• Within an Organization:
  • Merchants represent brands.
  • Stores represent physical or virtual locations under Merchants.
  • POIs are assigned to Stores.

Each object must be created in sequence (e.g. a POI cannot exist without a parent Store).

Note

BOM objects are separate from EMV Config objects — the linkage is through Organization ownership.