Diagram Legend & Conventions

To help you understand the integration workflows quickly, all flowcharts and diagrams across the Mipise Payment Services (MPS) documentation follow a strict, color-coded visual standard.


📘

We separate visual cues into two independent categories: Colors (to indicate the status of an object) and Border Styles (to indicate who is performing the action).

📖 Visual Legend

flowchart TD
    %% --- Colors = Status ---
    S([Creation / Initiation]):::draft ~~~ W[Requires Action / Suspended]:::update
    P[Pending / Processing]:::pending ~~~ C[Closed / Canceled]:::closed
    A[Active / Successful]:::active 

    %% --- Borders = Actors (Neutral Colors) ---
    INT[Internal MPS Action<br />Solid Border]:::internalActor ~~~ EXT[External System<br />Dashed Border]:::externalActor

    %% --- Styles ---
    classDef draft fill:#fff0f6,stroke:#c41d7f,stroke-width:2px
    classDef pending fill:#e6f7ff,stroke:#1890ff,stroke-width:2px
    classDef active fill:#f6ffed,stroke:#52c41a,stroke-width:2px
    classDef update fill:#fffbe6,stroke:#faad14,stroke-width:2px
    classDef closed fill:#f0f0f0,stroke:#8c8c8c,stroke-width:1px
    
    classDef internalActor fill:#ffffff,stroke:#333333,stroke-width:2px
    classDef externalActor fill:#ffffff,stroke:#333333,stroke-width:2px,stroke-dasharray: 5 5

🎨 1. Colors (Status & Lifecycle)

The background and border color of a node indicate its current operational state.

ColorCategoryBusiness Meaning
PinkCreationThe starting point of a workflow (e.g., Creating a User, initiating a Pay-out).
BluePendingAn intermediate state. The action has been received and is waiting for processing.
GreenSuccessThe "Happy Path." The object is fully validated, active, or the transaction has successfully settled.
YellowWarningA blockage. Action is required from your platform or the end-user to proceed (e.g., an expired document).
GreyTerminalThe end of a lifecycle. The object is closed, canceled, or definitively failed.

📐 2. Border Styles (Actors & Locations)

The style of the border (solid vs. dashed) indicates where the action takes place, regardless of its color/status.

Border StyleActor / LocationBusiness Meaning
Solid LineInternal (MPS or Platform)The action or state occurs within the MPS ecosystem or your platform (e.g., an API call, an internal account validation).
Dashed LineExternal SystemThe action occurs outside of the MPS ecosystem (e.g., the user's external bank, a 3D-Secure validation screen, or the SEPA network).