# mastercard/open-banking-us-openapi architecture

> Architecture diagram of the GitHub repository mastercard/open-banking-us-openapi, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mastercard/open-banking-us-openapi
- Repository: https://github.com/mastercard/open-banking-us-openapi

## Overview

This repository publishes Mastercard’s US Open Finance API specification and a Java test project that generates a client from it and exercises the APIs. The documented setup workflow creates a test customer, uses Connect to link bank accounts, and refreshes those accounts before tests run. The README supports these relationships; source excerpts were unavailable, so the graph avoids inferring API internals or unshown code-level calls.

Main entry points: [`bin`](https://github.com/mastercard/open-banking-us-openapi/tree/main/bin) (Setup scripts), [`tests/src/test/java/com/mastercard/openbanking/client/api`](https://github.com/mastercard/open-banking-us-openapi/tree/main/tests/src/test/java/com/mastercard/openbanking/client/api) (API test suite), [`openbanking-us.yaml`](https://github.com/mastercard/open-banking-us-openapi/blob/main/openbanking-us.yaml) (Open Finance API), [`tests`](https://github.com/mastercard/open-banking-us-openapi/tree/main/tests) (Generated API client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_spec["API specification"]
  node_specification["Open Finance API"]
end

subgraph group_setup["Test customer setup"]
  node_customer[("Test customer")]
  node_setup_script["Setup scripts"]
  node_connect["Connect application"]
  node_bank_profiles["Bank profiles"]
end

subgraph group_verification["Client verification"]
  node_generated_client["Generated API client"]
  node_api_tests["API test suite"]
end

node_developer(("API consumer"))
node_test_drive["Test Drive APIs"]

node_developer -->|"uses to integrate"| node_specification
node_specification -->|"generates client"| node_generated_client
node_setup_script -->|"adds customer"| node_customer
node_setup_script -->|"generates Connect URL"| node_connect
node_connect -->|"links accounts"| node_customer
node_bank_profiles -->|"provides accounts"| node_customer
node_setup_script -->|"refreshes accounts"| node_customer
node_api_tests -->|"uses client"| node_generated_client
node_api_tests -->|"tests APIs"| node_test_drive

click node_specification "https://github.com/mastercard/open-banking-us-openapi/blob/main/openbanking-us.yaml"
click node_setup_script "https://github.com/mastercard/open-banking-us-openapi/tree/main/bin"
click node_generated_client "https://github.com/mastercard/open-banking-us-openapi/tree/main/tests"
click node_api_tests "https://github.com/mastercard/open-banking-us-openapi/tree/main/tests/src/test/java/com/mastercard/openbanking/client/api"

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_specification toneBlue
class node_customer,node_setup_script,node_connect,node_bank_profiles toneAmber
class node_generated_client,node_api_tests,node_developer,node_test_drive toneMint
```

## Components

### API specification

- [Open Finance API](https://github.com/mastercard/open-banking-us-openapi/blob/main/openbanking-us.yaml): `openbanking-us.yaml`

### Test customer setup

- **Test customer**
- [Setup scripts](https://github.com/mastercard/open-banking-us-openapi/tree/main/bin): `bin`
- **Connect application**
- **Bank profiles**

### Client verification

- [Generated API client](https://github.com/mastercard/open-banking-us-openapi/tree/main/tests): `tests`
- [API test suite](https://github.com/mastercard/open-banking-us-openapi/tree/main/tests/src/test/java/com/mastercard/openbanking/client/api): `tests/src/test/java/com/mastercard/openbanking/client/api`

### Other components

- **API consumer**
- **Test Drive APIs**

## Connections

- API consumer → Open Finance API: uses to integrate (evidence: `README.md`)
- Open Finance API → Generated API client: generates client (evidence: `README.md`)
- Setup scripts → Test customer: adds customer (evidence: `README.md`)
- Setup scripts → Connect application: generates Connect URL (evidence: `README.md`)
- Connect application → Test customer: links accounts (evidence: `README.md`)
- Bank profiles → Test customer: provides accounts (evidence: `README.md`)
- Setup scripts → Test customer: refreshes accounts (evidence: `README.md`)
- API test suite → Generated API client: uses client (evidence: `README.md`)
- API test suite → Test Drive APIs: tests APIs (evidence: `README.md`)
