Use case

1. Query the list of customer’s overdraft accounts

API get-overdraft-by-cif

Objective

• Used to retrieve the customer’s overdraft accounts based on their CIF.
• Used to query detailed information for each overdraft account under the customer’s CIF.

Usage Scenario

The customer logs into the SuperApp and wants to view the list of their active overdraft accounts and the detailed information of each account.

1. The customer logs into the SuperApp.
2. The customer selects the Account tab and scroll to reach 'Overdraft'
3. The customer selects a specific overdraft account to view.

System action

Outcome

• If the CIF information is valid and meets all conditions, the system returns the list of valid overdrafr accounts along with the detailed information of each overdraft account.

• If the input information is invalid, the system returns the corresponding error messages.

Benefit

• For customer:

  • Instantly view the list of their owned overdraft accounts along with available balances, enabling convenient financial management.

  • Avoid confusion among different account types (e.g., current, savings, overdraft, etc.).

• For the system:

  • Standardize account data access points across multiple channels (Mobile, Web, API).

  • Minimize information leakage risks by enforcing access control based on CIF.

Error Handling

2. View Account Transaction History

API get-account-transactions

Purpose

• Used to retrieve the top 5 most recent transactions within the last 3 months for a specific overdraft account.
• Used to view the transaction history of an overdraft account within a selected time range.
• Used to query transactions based on filter conditions, checking both credit (incoming) and debit (outgoing) transactions.
• Used to view detailed information of a specific transaction. 

Usage Scenario

A customer logs into the SuperApp and wants to view the transaction history of an active overdraft account within a defined time range.

1. The customer logs into the SuperApp.
2. The customer selects the Account tab and scroll to reach 'Overdraft'
3. The customer selects a specific overdraft account to view.
4. The customer clicks [View More] to see the transaction history.
5. The customer clicks on a specific transaction to view its detailed information.

System action: SuperApp calls the get-list-transaction API.

Outcome

• If the account number is valid and meets all conditions, the system returns the transaction list of that account.
• If the account number is valid and meets all conditions but no transactions exist within the selected period, the system returns an empty list and a success response code.
• If the input information is invalid, the system returns the corresponding error messages.

Benefits

• For customers: Easily track and monitor their transaction history.
  • Quickly search for specific transactions by recipient, amount, or time.
  • Enhance transparency and control over personal spending management.
• For the system and the bank:
  • Standardize transaction retrieval across multiple channels (mobile/web).
  • Support related services such as spending analysis or transaction investigation.

Error Handling

3. View Account Spending Insights

API get-spends-insight-overdraft

Purpose

• Used to aggregate the spending of an overdraft account within a selected period and compare it with the previous period.

Usage Scenario

A customer logs into the SuperApp and wants to view the spending history and insights of an active overdraft account within a specific time range.

1. The customer logs into the SuperApp.
2. The customer selects the Account tab and scroll to reach 'Overdraft'
3. The customer selects one overdraft account.
4. The customer clicks Insight.
5. The customer selects the desired time range and overdraft account to view the spending insight.

System action

Outcome

• If the account number and time range are valid, the system returns the total spending information for the selected period and the previous period.
• If the input data is valid but there are no spending transactions during the selected period, the system returns 0 for total spending fields, along with a success response code.
• If the input data is invalid, the system returns the corresponding error messages.

Benefits

• For customers:
  • Understand their overall spending level and trends (increase/decrease) over time.
  • Easily plan spending and improve saving efficiency.
• For the bank:
  • Increase customer engagement and add more value to the digital banking experience.
  • Support the development of advanced features such as spending categorization, personalized financial product recommendations, and overspending alerts.
  • Utilize transaction data to enhance customer insights and analytics.

Error Handling

4. View insights on total incoming/outgoing transaction value by week within a month for an account

API get-overdraft-chart-weekly-trans

Purpose

• Used to aggregate the total incoming and total outgoing transaction value of the selected account over a one‑month period, grouped by week.

Use case

The customer logs in to the SuperApp; the default screen displays a chart of total outgoing and total incoming transaction values for the current month by week (Convention: each week has 7 days).

1. The customer logs in to the SuperApp.
2. The customer selects one account on Landing Page screen

System action

Outcome

→ If the account number and time range are valid, the system returns the total outgoing and total incoming transaction values for the current month, broken down by week.

→ If the input is valid and there are no spending (outgoing) transactions in the current month, the system returns 0 for the total spending fields along with a success response.

→ If the input is invalid, the system returns the corresponding error messages.

Benefits

• For customers:
  • Understand total inflows/outflows and their upward/downward trends over time.
  • Week‑to‑week comparison within a month makes it easier to plan spending and save effectively.
• For the bank:
  • Increases engagement and value‑add in the digital banking app.
  • Supports launching advanced features such as spending categorization, tailored financial product recommendations, and overspend alerts.
  • Leverages transaction data to develop customer insights (customer analytics).

Error Handling

5. Download Account Statement

API download-overdraft-statement

Purpose

• Used to generate and download account statements for a selected overdraft account within a defined period.

Usage Scenario

• The customer logs into the SuperApp and wants to download a detailed statement of a specific overdraft account.

System Action

• The system calls the download-overdraft-statement API to generate a statement file (PDF ) for the selected period.

Outcome

• If the input data is valid, the system successfully generates and returns the statement file.
• If the input data is invalid, the system returns the corresponding error messages.

Benefits

• For customers:
  • Quickly obtain detailed account statements for personal review, reconciliation, or record-keeping.
  • Support document requirements for financial proof or reporting.
• For the bank:
  • Enhance service convenience and self-service capabilities.
  • Reduce manual support requests and operational workload.