Skip to main content

BankLingo API Documentation

Welcome to the BankLingo Core Banking System API documentation. This comprehensive guide provides detailed information about all available APIs, request/response formats, and integration patterns.

Documentation Structure​

Our documentation is organized into two main categories for each feature:

🔧 Developer Documentation​

Technical documentation designed for software developers integrating with BankLingo APIs. Includes:

  • Detailed API specifications
  • Request/response schemas
  • Field-level documentation
  • Code samples
  • Error handling
  • Technical implementation notes

📊 Product Documentation​

Business-oriented documentation for demonstrations, training, and product understanding. Includes:

  • Feature overviews
  • Business use cases
  • Step-by-step guides
  • Screenshots and diagrams
  • Best practices
  • Configuration guidance

API Modules​

1. Clients Management​

Comprehensive customer relationship management including customer creation, updates, blacklisting, and approval workflows.

2. Branch Management​

Branch operations including branch setup, configuration, and closure procedures.

3. Vaults Management​

Branch vault management for cash handling and vault operations.

4. Till Accounts​

Teller till management including opening, closing, and cash movement operations.

5. Teller Transactions​

Day-to-day teller operations including deposits, withdrawals, and transfers.

6. Deposit Accounts​

Deposit account management including account creation, updates, and lifecycle management.

7. Deposit Transactions​

Deposit account transactions including deposits, withdrawals, transfers, and account locking.

8. Loan Accounts​

Loan account management including loan origination, approval workflows, and guarantor management.

9. Loan Transactions​

Loan transaction operations including disbursements, repayments, write-offs, and refinancing.

10. Execution Engine APIs​

Process orchestration, webhooks, and recurring jobs for automating business workflows and integrations.

11. BPMCore APIs​

Unified command-based APIs for core banking operations including accounts, documents, terminals, currency, comments, and activity logging.

API Standards​

Authentication​

All API requests require authentication using Bearer tokens. Include your API key in the request header:

Authorization: Bearer YOUR_API_TOKEN

Request Format​

All requests use JSON format with appropriate Content-Type header:

Content-Type: application/json

Response Structure​

Standard response format includes:

{
  "isSuccessful": true,
  "statusCode": "00",
  "message": "Operation completed successfully",
  "data": {},
  "pages": 1,
  "hasNext": false,
  "hasPrevious": false,
  "count": 10,
  "size": 10
}

Response Codes​

Common response codes are documented at the end of each API section.

Getting Started​

  1. Review the module overview relevant to your use case
  2. Navigate to the developer documentation for technical details
  3. Review sample requests and responses
  4. Test with the provided examples
  5. Consult product documentation for business context

Support​

For technical support, please contact:

Last Updated: December 17, 2025