Core Architecture & API Fundamentals

To build a robust integration with Mipise Payment Services (MPS), it is essential to understand the hierarchical relationship between your platform and the technical objects that drive financial operations.


1. The Hierarchical Structure

In MPS, data is organized in a strict "Top-Down" hierarchy to ensure legal segregation and operational clarity.

Visual Hierarchy: Platform > User > Account | Person

The following structure illustrates how your dedicated instance isolates and organizes data:

graph TD
    P[Platform: Your Segregated Environment] 
    P --> U1[User A: Digital Owner]
    P --> U2[User B: Digital Owner]
    
    subgraph "Individual Relationship (1:1)"
    U1 --- P1[Person: Natural Identity]
    U1 --- A1[Account: EUR]
    end

    subgraph "Business Relationship (1:N)"
    U2 --- P2[Person: Legal Entity]
    P2 --- P3[Person: Legal Rep]
    U2 --- A2[Account: EUR]
    end

    style P fill:#f9f,stroke:#333,stroke-width:4px
    style U1 fill:#bbf,stroke:#333,stroke-width:2px
    style U2 fill:#bbf,stroke:#333,stroke-width:2px
📘


2. Defining the Core Entities

  • Platform (The Container): Your independent, segregated environment. It acts as a "Sandbox" or "Production" instance where all your business rules, API keys, and webhooks live.
  • User (The Owner): The digital identity that holds the funds. It is identified by a unique email and login. A User is the bridge between the real world (Person) and the money (Account).
  • Person (The Identity): The legal representation of the User.
    • Natural Person: An individual.
    • Legal Person: A company or association.
      Note: A single User can be linked to multiple Persons (e.g., a Company + its Legal Representative + its UBOs).
  • Account (The Ledger): The digital vault where e-money is stored. An account is strictly mono-currency and belongs to exactly one User.

3. Global API Behavior & Principles

To ensure a smooth developer experience, our API follows a set of consistent rules across all endpoints.

A. Identification & UUIDs

Every object in MPS is identified by a UUID (Universally Unique Identifier).

  • platformUUID: Required for all requests to identify your environment.
  • userUUID, accountUUID, etc.: Used to target specific resources.

B. RESTful Standards

  • GET: Retrieve information (List or Details).
  • POST: Create or Update resources (e.g., creating a User or triggering a Pay-out).

C. Stateless & Secure

Each request must be authenticated via your API Keys. The API is stateless, meaning each call contains all the information necessary for MPS to process the request.

D. Real-time vs. Asynchronous

  • Immediate: Actions like P2P transfers or internal data updates happen in milliseconds.
  • Asynchronous: Actions involving external banking rails (Direct Debits, Pay-outs) or compliance reviews (KYC) update their status over time. Use Webhooks to stay synced with these changes.

4. Why this Structure Matters

  1. Strict Isolation: User A’s data or funds can never "leak" into User B’s scope.
  2. Audit Ready: Every movement is linked to a specific Account, which is linked to a specific User, verified by specific Persons.
  3. Scalability: You can manage thousands of Users and Accounts within a single Platform without increasing architectural complexity.

Next Step: Now that you understand the big picture, start by Creating your first User to begin the onboarding journey.