Overview
Overdraft management is a collection of APIs that provide the ability to retrieve, manage, and analyze customer overdraft account information within the banking system.
Based on the Customer Information File (CIF) — the unique identifier of each customer — the APIs within Overdraft management enable the system to display all account information (including overdraft accounts in Release 2).
This service is a core component of the Customer Data Platform, ensuring that all retrieved information is accurate, synchronized, and secure.
Why use these APIs?
The Overdraft management is used to:
- Provide a unified customer experience when logging into the digital banking application (Super App), allowing users to manage all their accounts in one place.
- Ensure data security by returning only the overdraft account information belonging to the authenticated CIF.
- Support intelligent queries for multiple purposes such as balance inquiry, transaction history lookup, statement download, and spending insights.
- Enable seamless integration between system layers (FE → BE → API Hub → Data Platform), ensuring data is continuously updated in real-time or near real-time.
Key features
Overdraft account list
- get-overdraft-by-cif
Retrieves the list of overdraft accounts associated with the customer’s CIF number, including basic information and detailed data of each specific account.
Transaction history
- get-account-transactions
Retrieves the top 5 most recent transactions within the last 3 months, or the full transaction list of an overdraft account within a selected date or month range, including incoming/outgoing transaction details, amount, description, and counterparty information.
Account insights
- get-spends-insight-overdraft
Retrieves the total spending of the overdraft account for the selected period, compared with the previous corresponding period, helping customers track and analyze their spending trends over time.
- get-overdraft-chart-weekly-trans
Retrieves the total incoming and outgoing transaction values of the selected overdraft account for each week within the current month, helping customers visualize their cash inflow and outflow trends on a weekly basis and manage their finances more effectively.
Account statement download
- download-overdraft-statement
Allows users to download the overdraft account statement by month. The backend system processes the request and returns a valid PDF file for download or storage.
