Files
proxmox/docs/04-configuration/OMNL_FINERACT_CONFIGURATION.md
defiQUG fbda1b4beb
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
docs: Ledger Live integration, contract deploy learnings, NEXT_STEPS updates
- ADD_CHAIN138_TO_LEDGER_LIVE: Ledger form done; public code review repo bis-innovations/LedgerLive; init/push commands
- CONTRACT_DEPLOYMENT_RUNBOOK: Chain 138 gas price 1 gwei, 36-addr check, TransactionMirror workaround
- CONTRACT_*: AddressMapper, MirrorManager deployed 2026-02-12; 36-address on-chain check
- NEXT_STEPS_FOR_YOU: Ledger done; steps completable now (no LAN); run-completable-tasks-from-anywhere
- MASTER_INDEX, OPERATOR_OPTIONAL, SMART_CONTRACTS_INVENTORY_SIMPLE: updates
- LEDGER_BLOCKCHAIN_INTEGRATION_COMPLETE: bis-innovations/LedgerLive reference

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-12 15:46:57 -08:00

2.6 KiB

OMNL Fineract API Configuration

Last updated: 2026-02-10
Tenancy: https://omnl.hybxfinance.io/

Overview

The OMNL tenancy runs Apache Fineract (Mifos) at https://omnl.hybxfinance.io/. API access uses Basic auth and a required tenant header.

Item Value
Base URL https://omnl.hybxfinance.io/fineract-provider/api/v1
Swagger UI swagger-ui/index.html
Tenant ID omnl
Auth Basic (username + password)

Credentials

  • Username: app.omnl
  • Password: Store only in .env or a secrets manager; do not commit.

Use the workspace root .env or the omnl-fineract/ directory env (see below).

Environment Variables

In root .env or omnl-fineract/.env:

OMNL_FINERACT_BASE_URL=https://omnl.hybxfinance.io/fineract-provider/api/v1
OMNL_FINERACT_TENANT=omnl
OMNL_FINERACT_USER=app.omnl
OMNL_FINERACT_PASSWORD=<your-password>

Root .env.example includes commented placeholders for these variables.

Submodule Directory: omnl-fineract/

The omnl-fineract directory at the repo root contains:

  • .env.example / .env.template — Template env files (no real password).
  • .gitignore — Ignores .env and logs.
  • README.md — Quick start and API reference.
  • SETUP.md — Step-by-step setup and verification.

To use it:

  1. cd omnl-fineract && cp .env.example .env
  2. Edit .env and set OMNL_FINERACT_PASSWORD.
  3. Source .env and run scripts or curl as in omnl-fineract/README.md.

This directory can later be moved to its own repository and added as a git submodule.

Verifying the API

# With env loaded (e.g. source .env)
curl -s -u "${OMNL_FINERACT_USER}:${OMNL_FINERACT_PASSWORD}" \
  -H "Fineract-Platform-TenantId: ${OMNL_FINERACT_TENANT}" \
  "${OMNL_FINERACT_BASE_URL}/offices"

Expected: HTTP 200 and a JSON array of offices.