Account & Transaction Management API

A RESTful API built with FastAPI to manage user accounts and transactions. It supports creating and updating accounts, recording deposit and withdrawal transactions, and retrieving transaction history. PostgreSQL is used as the database backend.

---

Features

• Create an account (POST /accounts/)
• Update an account (PUT /accounts/{account_id})
• Create a transaction (POST /transactions/)
• Get all transactions (GET /transactions/)
• FastAPI auto-generated Swagger UI (/docs) and ReDoc (/redoc)

---

Tech Stack

• Python
• FastAPI
• PostgreSQL
• SQLAlchemy
• Pydantic
• Docker & Docker Compose
• Pytest (for testing)

---

Installation & Setup

Prerequisites

• Docker
• Docker Compose
• make or Unix-like shell (for scripts)

Steps

1. Clone the repo:

git clone https://github.com/Zen121212/account-transaction-api.git
cd account-transaction-api

2. Start the containers:

./start.sh

3. Access API docs:

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc

4. Access pgAdmin: http://localhost:5051

pgAdmin 4 Setup:

After starting the Docker containers, you can configure pgAdmin to interact with PostgreSQL database.

1. Access pgAdmin 4: Open your browser and go to http://localhost:5051.

2. Log in: The default credentials for pgAdmin 4 are:

   • Username: admin@admin.com
   • Password: admin123

3. Register Server:

   • Name: Enter a name for your server, e.g., Postgres Server.
   • Connection Tab:
     • Hostname/address: Enter postgres_db.
     • Port: Enter 5432.
     • Maintenance database: Enter postgres.
     • Username: Enter postgres.
     • Password: Enter mysecretpassword.

4. Save: Click Save to register the server. You should now be able to interact with your PostgreSQL database via pgAdmin.

---

API Endpoints

📘 Create Account

POST /accounts/

{
  "name": "Zein",
  "email": "zein@example.com",
  "balance": 500.0,
  "phone": "12345678",
  "address": "Beirut"
}

---

📗 Update Account

PUT /accounts/{account_id}

{
  "name": "Zein Updated",
  "email": "zein@example.com",
  "balance": 1000.0
}

---

💰 Create Transaction

POST /transactions/

{
  "account_id": 1,
  "amount": 200.0,
  "transaction_type": "deposit"
}

---

📄 Get Transactions

GET /transactions/

Optional query params: account_id, start_date, end_date

---

Running Tests

To run tests using pytest, use the following command:

docker-compose exec backend pytest app/test_main.py

Test coverage includes:

• Creating an account
• Updating an account
• Creating a transaction (deposit/withdrawal)
• Validating insufficient funds
• Retrieving all transactions
• Filtering transactions by account

---

Design Decisions

• Used FastAPI for speed and automatic documentation generation.
• PostgreSQL chosen for reliability and compatibility with Docker.
• SQLAlchemy for ORM to ensure scalability and easier migration.

---

Assumptions

• Email is treated as a unique identifier for accounts.
• Transactions must link to a valid account.

---

Author

Zein Kassem - zein.s.kassem@gmail.com