# mojaloop/mojaloop-specification architecture

> Architecture diagram of the GitHub repository mojaloop/mojaloop-specification, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mojaloop/mojaloop-specification
- Repository: https://github.com/mojaloop/mojaloop-specification

## Overview

This repository is the Mojaloop Family of APIs specification: a collection of documents defining interoperable payment and related API capabilities, not a runtime implementation. Its central workflow is an end user initiating a cross-FSP transaction: the FSPIOP API specifies asynchronous messages between FSPs, either directly or through a Switch, to support transfer from payer to payee. The graph also preserves the documented API’s modeling, binding, security, and scheme-rule layers, plus Administration, Settlement, and Third-party APIs. Relationships reflect the README; source implementation was not sampled.

Main entry points: [`fspiop-api/documents/API-Definition_v1.1.md`](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/API-Definition_v1.1.md) (FSPIOP API), [`fspiop-api/documents/Generic-Transaction-Patterns.md`](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Generic-Transaction-Patterns.md) (Transaction patterns), [`fspiop-api/documents/Use-Cases.md`](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Use-Cases.md) (Use cases), [`fspiop-api/documents/Logical-Data-Model.md`](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Logical-Data-Model.md) (Logical data model)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_core["FSP interoperability"]
  node_fspiop["FSPIOP API"]
  node_transactions["Transaction patterns"]
  node_use_cases["Use cases<br/>[Use-Cases.md]"]
end

subgraph group_rules["API models and rules"]
  node_logical_model["Logical data model"]
  node_json_binding["JSON binding"]
  node_scheme_rules["Scheme rules<br/>[Scheme-Rules.md]"]
  node_security["Security guidance"]
end

subgraph group_adjacent["Other APIs"]
  node_admin_api["Administration API"]
  node_settlement_api["Settlement API"]
  node_thirdparty_api["Third-party API"]
  node_cross_network["Cross-network API"]
  node_reporting["Reporting API"]
end

subgraph group_participants["Transaction participants"]
  node_end_user(("End user"))
  node_payer_fsp["Payer FSP"]
  node_switch["Switch"]
  node_payee_fsp["Payee FSP"]
end

node_end_user -->|"initiates transaction"| node_payer_fsp
node_payer_fsp -->|"exchanges messages"| node_fspiop
node_fspiop -.->|"routes through"| node_switch
node_fspiop -->|"supports transfer"| node_payee_fsp
node_transactions -->|"defines logical patterns"| node_fspiop
node_use_cases -->|"describes transaction flows"| node_fspiop
node_logical_model -->|"specifies data model"| node_fspiop
node_json_binding -->|"defines JSON binding"| node_fspiop
node_scheme_rules -->|"defines scheme rules"| node_fspiop
node_security -->|"guides deployment security"| node_fspiop

click node_fspiop "https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/API-Definition_v1.1.md"
click node_transactions "https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Generic-Transaction-Patterns.md"
click node_use_cases "https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Use-Cases.md"
click node_logical_model "https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Logical-Data-Model.md"
click node_json_binding "https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/JSON-Binding-Rules.md"
click node_scheme_rules "https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Scheme-Rules.md"
click node_security "https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/PKI-Best-Practices.md"
click node_admin_api "https://github.com/mojaloop/mojaloop-specification/blob/master/admin-api/admin-api-specification-v1.0.md"
click node_settlement_api "https://github.com/mojaloop/mojaloop-specification/blob/master/settlement-api/settlement-api-specification-v1.1.md"
click node_thirdparty_api "https://github.com/mojaloop/mojaloop-specification/blob/master/thirdparty-api/thirdparty-pisp-v1.0.yaml"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_fspiop,node_transactions,node_use_cases toneBlue
class node_logical_model,node_json_binding,node_scheme_rules,node_security toneAmber
class node_admin_api,node_settlement_api,node_thirdparty_api,node_cross_network,node_reporting toneMint
class node_end_user,node_payer_fsp,node_switch,node_payee_fsp toneRose
```

## Components

### FSP interoperability

- [FSPIOP API](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/API-Definition_v1.1.md): `fspiop-api/documents/API-Definition_v1.1.md`
- [Transaction patterns](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Generic-Transaction-Patterns.md): `fspiop-api/documents/Generic-Transaction-Patterns.md`
- [Use cases](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Use-Cases.md): `fspiop-api/documents/Use-Cases.md`

### API models and rules

- [Logical data model](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Logical-Data-Model.md): `fspiop-api/documents/Logical-Data-Model.md`
- [JSON binding](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/JSON-Binding-Rules.md): `fspiop-api/documents/JSON-Binding-Rules.md`
- [Scheme rules](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/Scheme-Rules.md): `fspiop-api/documents/Scheme-Rules.md`
- [Security guidance](https://github.com/mojaloop/mojaloop-specification/blob/master/fspiop-api/documents/PKI-Best-Practices.md): `fspiop-api/documents/PKI-Best-Practices.md`

### Other APIs

- [Administration API](https://github.com/mojaloop/mojaloop-specification/blob/master/admin-api/admin-api-specification-v1.0.md): `admin-api/admin-api-specification-v1.0.md`
- [Settlement API](https://github.com/mojaloop/mojaloop-specification/blob/master/settlement-api/settlement-api-specification-v1.1.md): `settlement-api/settlement-api-specification-v1.1.md`
- [Third-party API](https://github.com/mojaloop/mojaloop-specification/blob/master/thirdparty-api/thirdparty-pisp-v1.0.yaml): `thirdparty-api/thirdparty-pisp-v1.0.yaml`
- **Cross-network API**
- **Reporting API**

### Transaction participants

- **End user**
- **Payer FSP**
- **Switch**
- **Payee FSP**

## Connections

- End user → Payer FSP: initiates transaction (evidence: `README.md`)
- Payer FSP → FSPIOP API: exchanges messages (evidence: `README.md`)
- FSPIOP API → Switch: routes through (evidence: `README.md`)
- FSPIOP API → Payee FSP: supports transfer (evidence: `README.md`)
- Transaction patterns → FSPIOP API: defines logical patterns (evidence: `README.md`)
- Use cases → FSPIOP API: describes transaction flows (evidence: `README.md`)
- Logical data model → FSPIOP API: specifies data model (evidence: `README.md`)
- JSON binding → FSPIOP API: defines JSON binding (evidence: `README.md`)
- Scheme rules → FSPIOP API: defines scheme rules (evidence: `README.md`)
- Security guidance → FSPIOP API: guides deployment security (evidence: `README.md`)
