API Reference
The Apache Fineract API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URL
Authentication
The Fineract API uses HTTP Basic Authentication. Include your credentials in the Authorization header and specify the tenant ID.
Authorization: Basic base64(username:password) Fineract-Platform-TenantId: default Content-Type: application/json
API Resources
Clients
Manage client information, identifiers, images, addresses, and client-related transactions
Loans
Complete loan lifecycle management including applications, approvals, disbursements, repayments, and write-offs
Savings Accounts
Manage savings accounts including deposits, withdrawals, interest calculation, and account lifecycle
Fixed Deposit Accounts
Manage fixed deposit accounts with maturity tracking, premature closure, and interest calculations
Recurring Deposit Accounts
Manage recurring deposit accounts with scheduled deposits and maturity tracking
Groups
Manage groups, centers, and group lending (JLG/GLIM) functionality
Accounting
General ledger accounts, journal entries, accounting rules, and financial reporting
Organization
Office hierarchy, staff management, loan/savings products, charges, funds, currencies, and organizational settings
Users
User management, authentication, roles, and permissions
System
System configuration, codes, datatables, reports, scheduled jobs, and audit logs
Batch API
Execute multiple API calls in a single request for improved performance
Was this page helpful?