FinServ API Documentation - Introduction

FinServ API Documentation

Welcome to the FinServ API Suite. This platform provides secure, reliable, and scalable access to FinServ’s digital banking services. It enables developers, financial institutions, and fintech partners to integrate seamlessly with core banking features such as customer onboarding, account management, transactions, loans, and reporting.

Key Features

  • Secure Authentication: All endpoints require API key headers.
  • Consistent JSON Responses: Easy to parse and integrate into applications.
  • Error Handling: Standardized error codes (400, 401, 403, 404) with descriptive messages.
  • Scalability: Designed to support high-volume financial transactions.
  • Coverage: Supports customer onboarding, account management, transactions, loans, and reporting.

Summary of Available APIs

API Purpose Key Parameters (Request) Key Fields (Response)
Balance Check Retrieve current account balance accountNumber, x-api-key accountNumber, balance, currency, status
Deposit Credit funds into an account accountNumber, amount, x-api-key transactionId, accountNumber, amount, status
Withdrawal Debit funds from an account accountNumber, amount, x-api-key transactionId, accountNumber, amount, status
Transfer Move funds between accounts sourceAccount, destinationAccount, amount, x-api-key transactionId, sourceAccount, destinationAccount, amount, status
Transaction History Retrieve last 50 transactions accountNumber, x-api-key transactions[] (date, type, amount, balance, status)
Customer Registration Register a new customer firstName, lastName, email, phoneNumber, address, x-api-key customerId, firstName, lastName, email, phoneNumber, address, status
Account Opening Open a new account for a registered customer customerId, accountType, initialDeposit, x-api-key accountNo, customerId, accountType, initialDeposit, status
Loan Application Submit a loan request customerId, accountId, loanType, amount, repaymentFrequency, repaymentPeriod, x-api-key loanId, customerId, accountId, loanType, amount, repaymentFrequency, repaymentPeriod, status
Loan Repayment Record repayment against a loan schedule loanId, scheduleId, scheduleDate, amount, x-api-key repaymentId, loanId, scheduleId, scheduleDate, amountPaid, status
Loan Status Check current loan status loanId, x-api-key principal, totalRepayment, balance, status
Customer Search Retrieve customer details customerId, x-api-key firstName, lastName, status, branch, accountOfficer, telephone
Account Search Retrieve account details accountNumber, x-api-key accountName, accountNumber, accountType, dateOpened, lastActiveDate
Note: Always use HTTPS to protect sensitive data. Rotate API keys regularly for security.

Architecture Overview

The FinServ API Suite is built on a secure, modular, and scalable architecture. It ensures that clients interact with the system through a controlled API Gateway, which routes requests to specialized microservices and communicates with the core banking database.

High-Level Components

  • Client Layer: Mobile apps, web applications, and third-party fintech integrations.
  • API Gateway: Entry point for all requests. Handles routing, authentication, rate limiting, and logging.
  • Service Layer (Microservices):
    • Customer Service – registration, search, update
    • Account Service – opening, search, balance check
    • Transaction Service – deposit, withdrawal, transfer, history
    • Loan Service – application, repayment, status
    • Reporting Service – statements, analytics
  • Security Layer: API key authentication, role-based authorization, HTTPS/TLS encryption, audit logging.
  • Data Layer: Core banking database, reporting warehouse, and caching layer for performance.
  • External Integrations: Payment gateways, notification services (SMS/Email), regulatory systems.

Flow Summary

Step 1: Client sends request → API Gateway

Step 2: Gateway authenticates request → routes to correct microservice

Step 3: Microservice processes request → queries database/cache

Step 4: Response returned → Gateway → Client

Step 5: Logs and audit trail stored for compliance

Note: This architecture ensures scalability, modularity, and security. New services (e.g., Cards, Bill Payments) can be added without disrupting existing APIs.