Admin APIs (1.0)
Download OpenAPI specification:Download
Our Administrative APIs serves as a centralized interface for Admin Users, Legacy Systems or Third Parties to perform essential actions within the Core Banking Platform.
Tailored specifically for administrative tasks, this API facilitates the setup and configuration of the platform, allowing Users to define parameters, functionalities, and manage administrative functions required for a succesful operation of the overall of the system.
From configuring product to extracting reports and data analytics, the Internal APIs empowers users to efficiently oversee and optimize the performance of the Core Banking Platform allowing for easy adaptation and efficient traceability.
The following Methods are divided into the following categories:
| Category | Purpose |
|---|---|
| Authentication | API for authentication and security methods, including access control and verification of admin or third-party users, ensuring secure interactions. |
| Profile | API for profile management, handling user data efficiently to ensure secure storage, updating, and retrieval of user information. |
| Debit | API for debit module functionalities, enabling account creation, transaction management, balance inquiries, and real-time processing. |
| Deposit | API for deposit module functionalities, facilitating account creation, deposit management, interest calculations, and real-time updates. |
| Lending | API for lending module functionalities, supporting loan applications, payment plans, disbursements, and real-time management of credit accounts. |
| Transaction | API for transaction methods, managing incoming, outgoing, and internal transactions efficiently and securely. |
CreateAlertBalanceAccounts
API method to create an alert when an account balance surpasses a threshold, notifying a set of internal users via email. The alert includes a counter to track the number of times it can be executed, ensuring effective monitoring of account balances.
path Parameters
|
accountId
required
|
string
|
GetAccountSchemes
API method to consult the list of schemes for debit products, providing comprehensive details on existing schemes, including names, aliases, accounting accounts, product numbers, and primary numbers, ensuring users can effectively manage and review debit product configurations.
path Parameters
|
branchId
required
|
string
|
GetBalance
API method to obtain current account balance, in-transit balance, average balance, return rate, and details of incoming and outgoing transactions per month and per day, ensuring comprehensive financial insights and effective account management.
path Parameters
|
branchId
required
|
string
|
|
accountId
required
|
string
|
UpdateAccount
API method to update information of an existing debit product, allowing modifications to parameters such as name, alias, description, accounting account, product number, primary number, limits, commissions, and returns for accurate product management.
path Parameters
|
accountId
required
|
string
|
BalanceAdjustmentAuthorize
API method to create an internal adjustment transaction between operational accounts or user accounts by performing an authorization, including a specific amount, concept, comment, and transaction coordinates, ensuring secure and efficient fund transfers within the system. This transaction is pending to be confirmed.