Virtual TPE Instances
The core containers that organize your payment flows.
What is an Instance?
In the MyTPE Pay ecosystem, an Instance is a Virtual Payment Terminal (Virtual TPE).
Think of it as a digital version of the physical card machine you see in shops. Just as a large supermarket might have 10 physical machines (one for each cashier), your digital business can have multiple Virtual Instances to separate your revenue streams.
The Hierarchy
Instances are the "Parent" entities. Every Payment Link you create must belong to a specific Instance. This allows for perfect financial segregation.
Isolation Logic
Each instance has its own Logo, Name, and Transaction History. Reporting is calculated per instance, allowing you to see exactly which branch of your business is performing best.
Use Cases: Why multiple instances?
You typically create a new instance when you need to separate branding or accounting between different parts of your business.
Scenario 1: The Supermarket Chain
User: A large retailer like "UNO" or "Ardis" with multiple locations.
The Setup
The finance director creates distinct instances for each major location: "Hypermarket Algiers" and "Hypermarket Oran".
- Accounting: Revenue is automatically separated by city. The finance team can filter "Total Sales from Oran" instantly without complex spreadsheets.
- Access Control: The manager of the Oran store is given API keys only for the "Oran" instance, ensuring they cannot accidentally refund transactions from the Algiers store.
Scenario 2: The Delivery App
User: A logistics company like "Yassir" or "Temtem" that handles different types of services.
The Setup
They create two instances: "Food Delivery" and "B2B Logistics".
- Branding: Customers paying for a burger see the "Food" logo on the checkout page. Corporate clients paying for truck shipping see the "Logistics" branding.
- Link Logic: The Food instance uses simple "Standard Links" for orders. The B2B instance uses "One-Shot" links to send high-value invoices to companies.
Lifecycle & Activation
Unlike Payment Links (which are free to create), an Instance often represents a formal "Terminal" and may require activation.
Activation Process
- Creation: You define the name (e.g.,
My Store) and upload a logo. The status starts aspending_payment. - Fee Payment:
- Online: Pay the activation fee using a CIB/EDAHABIA card. Activation is instant.
- Offline: Upload a receipt of bank transfer (Virement). Activation occurs after Admin Validation.
- Active: The instance can now generate payment links and process transactions.
Deletion Constraint
You can only delete an instance if it has zero transaction history. If an instance has processed payments, it must be archived (set to inactive) instead to preserve audit logs.
Open in Postman