Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Replace Payment flow image with Mermaid chart #430

Merged
merged 1 commit into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/usage-guide/company-registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,28 @@ order: 3

The below diagram depicts the integration layers of MPM with mobile money providers and device manufacturers (whether electricity meter, SHS or e-bike).

![Plugin Integration Overview](images/plugin-integration-overview.png)
```mermaid
sequenceDiagram
actor c as Customer
participant mmp as Mobile Money Provider
participant mpm as MicroPowerManager
participant mm as Meter Manufacturer

c->>mmp: Make payment
activate mmp
mmp->>mpm: Call Validation API
activate mpm
mpm->>mpm: Make Validations
mpm->>mmp: Return Validation Response
mmp->>mpm: Call Process API
deactivate mmp
mpm->>mm: Call Token Generation API
activate mm
mm->>mpm: Return Token
deactivate mm
mpm->>c: Send Token to customer
deactivate mpm
```

In order to use MPM software to manage your customer portfolio, you will have to activate the relevant (manufacturer) plug-ins as well as the relevant telecommunication provider plug-ins.
For example, if you have Calin pre-paid meters or SunKing Solar Home Systems in your portfolio, you should activate the “Calin” and “SunKing” plug-ins to be able to manage your customers with MPM software. Additionally, if your customers rely on Airtel or Vodacom, you should activate the applicable Airtel or Vodacom plug-ins to enable MPM to generate tokens when receiving mobile money payments.
Expand Down
Binary file not shown.
Loading