# Mambu Documentation Hub
# llms.txt — AI traversal index
# Last Updated: 2026-06-26
# Standard: https://llmstxt.org

## Overview

Mambu is a cloud banking platform. This site provides user guides, release notes,
API reference (v1 and v2), and integration documentation.

Base URL: https://docs.mambu.com

---

## TL;DR — read this first

Two access patterns. Pick by the URL shape, not the topic:

1. **API endpoint reference** (anything under `/api/api-v2/`, `/api/api-v1/`,
   `/api/streaming/`, `/api/payments-mpg/`, `/api/audit-trail/`):
   **DO NOT** fetch the HTML page — it is a JavaScript-rendered SPA shell with
   no useful content for non-browser agents. **DO NOT** try the `/md/` pattern
   for these URLs either — it is not provided.
   **DO** fetch the raw OpenAPI spec:
   - `/api/api-v2/{resource}/{operation}` → `/swagger_files/v2/{resource}.json`
   - `/api/api-v1/{resource}/{operation}` → `/swagger_files/v1/{resource}.json`
   - `/api/streaming/...`                 → `/swagger_files/streaming.json`
   - `/api/payments-mpg/...`              → `/swagger_files/payments-mpg/payments.yaml`
   - `/api/audit-trail/...`               → `/swagger_files/audit-trail/openapi.yaml`
   Each spec file covers every endpoint for that resource (method, path,
   parameters, request/response schemas) — usually a single fetch answers
   the question. Start with the manifest:
   `https://docs.mambu.com/swagger_files/v2/index.json` (lists all 104 v2 specs).

2. **Everything else** (user guides, release notes, API overview/concept pages
   under `/docs/...` or `/api/pages/...`):
   Fetch the markdown version: `https://docs.mambu.com/md/{path}.txt`
   (e.g. `/md/api/pages/api-v2/authentication.txt`).

For broad-context loading of all human-authored docs in one fetch, see
`llms-full.txt` below.

### Important: Trailing slashes and no-slash redirects
Due to a known infrastructure configuration, fetching a documentation URL without a trailing slash (e.g. `https://docs.mambu.com/docs/foo`) may return the site's homepage HTML instead of the specific page.
- **ALWAYS** use the `/md/{path}.txt` pattern for fetching content (e.g. `https://docs.mambu.com/md/docs/foo.txt`). These URLs are served reliably.
- If you must fetch HTML, ensure you include the trailing slash (e.g. `https://docs.mambu.com/docs/foo/`).

---

## How to traverse this site (detail)

### Broad questions / full-site context
Fetch: https://docs.mambu.com/llms-full.txt
- ~3.3 MB of clean markdown — large; use only when full-corpus search is needed
- 417 user-guide and API-overview pages + 104 API v2 resource specs (endpoint summaries)
- One fetch gives you the complete human-authored documentation
- Excludes the 3,000+ auto-generated OpenAPI reference pages — for those, fetch
  the raw OpenAPI specs under /swagger_files/ instead (see "OpenAPI specifications"
  below). The specs cover every endpoint, parameter, and schema in structured form.
- For single-page lookups, prefer the per-page /md/ endpoint below

### API endpoint reference (per-endpoint details)
The 3,000+ rendered pages under /api/api-v2/, /api/api-v1/, /api/streaming/,
/api/payments-mpg/, and /api/audit-trail/ are NOT available as markdown via /md/.
For machine-readable per-endpoint detail (method, path, parameters, request/response
schemas), fetch the corresponding raw OpenAPI spec file under /swagger_files/ —
see the "OpenAPI specifications" section below. One spec file covers all endpoints
for a resource, so a single fetch typically answers the question.

### Targeted questions about a specific topic
1. Scan https://docs.mambu.com/ai-sitemap-docs.txt to find the relevant URL
   (~86 KB, pipe-delimited: URL | Title | Description)
   Covers all user-guide and API overview pages — fits in any context window.
   Note: the sitemap lists HTML URLs. Convert to a /md/ fetch using the pattern below.
   (For the full 3,200-entry sitemap including API spec pages: /ai-sitemap.txt)
2. Fetch the page as plain text using the /md/{path}.txt pattern below

### Per-page raw markdown (one-hop fetch, no HTML extraction)
User-guide pages and top-level API guide pages are available as plain text under /md/.
Use these when HTML extraction is unreliable or returns wrong content.

Pattern: https://docs.mambu.com/md/{path}.txt  (preferred — returns text/plain universally)
Alt:     https://docs.mambu.com/md/{path}.md   (for standards-compliant tools that handle .md)

Coverage rules — which URLs convert to /md/ and which DO NOT:

| HTML URL prefix                          | /md/ available?        | What to do                                                  |
|------------------------------------------|------------------------|-------------------------------------------------------------|
| /docs/{slug}                             | ✓ /md/docs/{slug}.txt  | Fetch the /md/ equivalent.                                  |
| /api/pages/{api}/{slug}                  | ✓ /md/api/pages/...    | Fetch the /md/ equivalent (auth, base-urls, pagination etc.)|
| /api/api-v2/{resource}/{operation}       | ✗ NOT in /md/          | Fetch /swagger_files/v2/{resource}.json (see below).        |
| /api/api-v2/{resource}/{resource}-overview | ✗ NOT in /md/        | Fetch /swagger_files/v2/{resource}.json (see below).        |
| /api/api-v1/{resource}/{operation}       | ✗ NOT in /md/          | Fetch /swagger_files/v1/{resource}.json (see below).        |
| /api/streaming/...                       | ✗ NOT in /md/          | Fetch /swagger_files/streaming.json.                        |
| /api/payments-mpg/...                    | ✗ NOT in /md/          | Fetch /swagger_files/payments-mpg/payments.yaml.            |
| /api/audit-trail/...                     | ✗ NOT in /md/          | Fetch /swagger_files/audit-trail/openapi.yaml.              |

Do NOT attempt `/md/api/api-v2/...` style URLs — they return the SPA homepage HTML
(content-type: text/html, ~40 KB), not the page you asked for. Only `/md/docs/...` and
`/md/api/pages/...` are guaranteed to resolve. For per-endpoint API reference, the
authoritative source is the OpenAPI spec — see "OpenAPI specifications" below.

Examples:
- https://docs.mambu.com/md/docs/carry-forward-balances-at-reschedule-or-refinance.txt
- https://docs.mambu.com/md/api/pages/api-v2/authentication.txt

### This file (llms.txt)
Use as a quick orientation: key URLs, data model, auth patterns, integration entry points.
8 KB — fits in any context window.

### Do NOT use these for direct LLM consumption
The following are provided for programmatic and vector-DB use only.
They are too large or too noisy for direct context-window loading:
- /docs-export.json — 35 MB full export
- /docs-rag-chunks.json — 16 MB, 10,101 pre-chunked segments (use for vector DB ingestion)
- /ai-manifest.json — 2.5 MB structured navigation index (use for programmatic crawling)
- /sitemap.xml — standard XML sitemap for web crawlers

---

## Key documentation areas

### User Guide
Entry point: https://docs.mambu.com/docs
Covers product features, configuration, best practices, and workflows.

### API v2 (recommended)
Entry point: https://docs.mambu.com/api/pages/api-v2/welcome
- Modern REST API, full CRUD
- JSON request/response
- OAuth 2.0 authentication
- Covers: Accounts, Loans, Deposits, Clients, Transactions, Custom Fields

### API v1 (legacy, still supported)
Entry point: https://docs.mambu.com/api/pages/api-v1/welcome
- Basic authentication
- Core banking operations

### Streaming API
Entry point: https://docs.mambu.com/api/pages/streaming/streaming-index
- Real-time event streaming via WebSocket and HTTP

### Mambu Payment Gateway (MPG)
Entry point: https://docs.mambu.com/api/pages/payments-mpg/welcome

### Mambu Payments (Numeral)
Reference: https://docs.numeral.io/reference/introduction

---

## Core data model

- **Clients** — individuals or groups (borrowers, account holders)
- **Accounts** — savings accounts and loan accounts
- **Products** — loan products and deposit products (templates for accounts)
- **Transactions** — deposits, withdrawals, repayments, fee charges
- **Custom Fields** — extensible metadata on any entity
- **Branches / Centers** — organisational hierarchy

---

## Authentication

- **OAuth 2.0** — recommended for API v2
- **Basic Auth** — supported on both v1 and v2
- **API Keys** — supported

---

## Top entry points by topic

Curated, fetch-ready URLs covering the highest-traffic tasks. Not exhaustive —
for full coverage use llms-full.txt (broad context) or ai-sitemap.txt (lookup).

### Getting started & data model
- https://docs.mambu.com/docs/ — Welcome to Mambu
- https://docs.mambu.com/docs/developer-overview/ — Developer overview
- https://docs.mambu.com/docs/clients-and-groups-overview/ — Clients & groups concepts
- https://docs.mambu.com/docs/managing-your-organization-overview/ — Organization setup

### Authentication & API access
- https://docs.mambu.com/api/pages/api-v2/welcome/ — API v2 welcome
- https://docs.mambu.com/api/pages/api-v2/authentication/ — Auth methods (OAuth, API keys, Basic)
- https://docs.mambu.com/api/pages/api-v2/base-urls/ — Base URLs (production / sandbox)
- https://docs.mambu.com/api/pages/api-v2/sandbox/ — Sandbox tenant
- https://docs.mambu.com/docs/api-consumers/ — API consumers & key generation
- https://docs.mambu.com/api/pages/api-v1/welcome/ — API v1 welcome (legacy)

### Loans (lifecycle & operations)
- https://docs.mambu.com/api/api-v2/loans/loans-overview/ — Loans API overview
- https://docs.mambu.com/docs/loan-account-overview-details/ — Loan account details
- https://docs.mambu.com/docs/creating-a-new-loan/ — Create a loan
- https://docs.mambu.com/docs/disbursing-a-loan/ — Disburse a loan
- https://docs.mambu.com/docs/closing-a-loan-with-all-obligations-met/ — Close a loan
- https://docs.mambu.com/docs/arrears-settings/ — Arrears handling
- https://docs.mambu.com/docs/carry-forward-balances-at-reschedule-or-refinance/ — Reschedule / refinance

### Deposits
- https://docs.mambu.com/api/api-v2/deposits/deposits-overview/ — Deposits API overview
- https://docs.mambu.com/docs/deposit-account-overview-details/ — Deposit account details
- https://docs.mambu.com/docs/deposit-products-configuration/ — Deposit product setup
- https://docs.mambu.com/docs/creating-a-deposit-account/ — Create a deposit account
- https://docs.mambu.com/docs/deposits-withdrawals-and-transfers/ — Day-to-day operations
- https://docs.mambu.com/docs/deposit-accounts-life-cycle-and-states/ — Lifecycle states

### Clients & groups
- https://docs.mambu.com/api/api-v2/clients/clients-overview/ — Clients API overview
- https://docs.mambu.com/docs/create-an-individual-client/ — Create an individual client
- https://docs.mambu.com/docs/creating-a-group/ — Create a group
- https://docs.mambu.com/docs/client-life-cycle/ — Client lifecycle states

### Transactions
- https://docs.mambu.com/docs/adjusting-transactions/ — Adjusting / reversing transactions
- https://docs.mambu.com/docs/transaction-channels/ — Transaction channels
- https://docs.mambu.com/api/api-v2/deposits_transactions/make-deposit.api — Make a deposit
- https://docs.mambu.com/api/api-v2/deposits_transactions/make-withdrawal-async.api — Make a withdrawal
- https://docs.mambu.com/api/api-v2/deposits_transactions/make-transfer.api — Make a transfer

### Webhooks & event streaming
- https://docs.mambu.com/docs/notifications-channels-webhooks-overview/ — Webhooks overview
- https://docs.mambu.com/docs/notifications-channels-webhooks-defining-a-new-webhook/ — Define a webhook
- https://docs.mambu.com/docs/notifications-channels-webhooks-best-practices/ — Webhook best practices
- https://docs.mambu.com/docs/notifications-channels-streaming-streaming-api/ — Streaming API guide
- https://docs.mambu.com/api/pages/streaming/streaming-index/ — Streaming API reference

### Custom fields
- https://docs.mambu.com/api/api-v2/customfields/customfields-overview/ — Custom fields API
- https://docs.mambu.com/docs/configuration-as-code-for-custom-fields/ — Configure via CasC
- https://docs.mambu.com/api/pages/api-v2/searching-by-custom-fields/ — Search by custom field

### Accounting
- https://docs.mambu.com/docs/accounting-setup/ — Accounting setup
- https://docs.mambu.com/docs/creating-your-chart-of-accounts/ — Chart of accounts
- https://docs.mambu.com/docs/cash-vs-accruals-accounting/ — Cash vs accruals methodology
- https://docs.mambu.com/docs/accounting-closures/ — Period closures
- https://docs.mambu.com/docs/accounting-reports/ — Accounting reports

### Search, pagination & performance
- https://docs.mambu.com/api/pages/api-v2/searching-for-records/ — Search syntax
- https://docs.mambu.com/api/pages/api-v2/cursor-based-search-pagination/ — Cursor pagination (recommended)
- https://docs.mambu.com/api/pages/api-v2/pagination/ — Offset pagination
- https://docs.mambu.com/api/pages/api-v2/optimising-searches/ — Performance tips
- https://docs.mambu.com/api/pages/api-v2/idempotency/ — Idempotency keys

---

## OpenAPI specifications (machine-readable)

Raw upstream OpenAPI specs are published as static files. These are the
unmodified specs as the API service exposes them (no docs-site adaptations
like proxy server URLs or stripped security schemes). The rendered API
reference pages under /api/api-v2/* are generated from these same specs.

### v2 (current) — split per resource

Discover the full list of v2 spec files via the manifest:
- https://docs.mambu.com/swagger_files/v2/index.json — manifest of 104 resource specs (title, version, path count, URL)

Each entry in the manifest gives a direct URL like:
- https://docs.mambu.com/swagger_files/v2/clients.json
- https://docs.mambu.com/swagger_files/v2/loans.json
- https://docs.mambu.com/swagger_files/v2/deposits.json
- https://docs.mambu.com/swagger_files/v2/cards.json
- https://docs.mambu.com/swagger_files/v2/accounting_interestaccrual.json
- ... (99 more — fetch the manifest for the complete list)

### v1 (legacy) — split per resource

- https://docs.mambu.com/swagger_files/v1/index.json — manifest of 34 resource specs

### Single-file specs

- https://docs.mambu.com/swagger_files/streaming.json — Streaming API (Event Streaming)
- https://docs.mambu.com/swagger_files/payments-mpg/payments.yaml — Payments MPG Payment Order API
- https://docs.mambu.com/swagger_files/payments-mpg/external_gateway.yaml — Payments MPG external gateway
- https://docs.mambu.com/swagger_files/audit-trail/openapi.yaml — Audit Trail API

---

## External resources

- Status page: https://status.mambu.com
- Ecosystem / integrations: https://ecosystem.mambu.com
- Support: https://docs.mambu.com/docs/mambu-support
- Company: https://www.mambu.com

---

Format: llms.txt — https://llmstxt.org