Skip to content

A developer-first banking sandbox for building and testing fintech applications locally.

License

Notifications You must be signed in to change notification settings

ranjankumar-gh/devbanksdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DevBank SDK

A developer-first banking sandbox for building and testing fintech applications locally.

What is DevBank SDK?

DevBank SDK provides a complete banking backend that runs on your machine via Docker. It includes realistic APIs, synthetic data generation, and a transaction engine that simulates real banking activity—scheduled payments, random purchases, delays, failures, and even fraud scenarios.

Build your fintech app against real banking APIs without signing up for sandbox accounts or dealing with rate limits.

Features

  • Full Banking API - Customers, accounts, transactions, cards
  • Realistic Data Generator - Synthetic customers with transaction history
  • Transaction Engine - Automated activity including:
    • Scheduled bill payments
    • Random merchant transactions
    • Salary deposits
    • Transaction delays and failures
    • Fraud scenario simulation
  • Developer CLI - Manage data from the command line
  • Docker Ready - One command to start everything

Quick Start

# Start all services
cd docker
docker-compose up -d

# Verify it's running
curl http://localhost:8000/health

# Open API docs
open http://localhost:8000/docs

For detailed setup instructions and API examples, see the Quick Start Guide.

API Overview

Resource Endpoints
Customers Create, list, get, update, delete
Accounts Create, list, balance, freeze/unfreeze, close
Transactions Create, list, transfer, reverse, simulate pending/failure
Cards Create, list, freeze/unfreeze, cancel

All endpoints available at http://localhost:8000/api/v1/

CLI Usage

# Install dependencies
pip install -r requirements.txt

# Check status
python -m cli.devbank status

# Generate test data
python -m cli.devbank generate customers --count 10

# List accounts
python -m cli.devbank accounts list

# Transfer money
python -m cli.devbank transactions transfer

Transaction Engine

The transaction engine runs in the background and generates realistic banking activity:

  • Scheduled Payments - Bills auto-pay on realistic schedules
  • Random Transactions - Merchant purchases throughout the day
  • Pending States - Transactions complete after realistic delays
  • Failures - 2% of transactions fail randomly
  • Fraud Scenarios - Test your fraud detection with:
    python -m cli.devbank generate fraud <account_id> --scenario skimming

Project Structure

DevBankSDK/
├── docker/           # Docker Compose setup
├── api/              # FastAPI backend
├── cli/              # Command-line tool
├── data/             # Data generator
├── engine/           # Transaction engine
└── docs/             # Documentation

Requirements

  • Docker and Docker Compose
  • Python 3.10+ (for CLI)

Documentation

  • Quick Start Guide - Get running in 5 minutes
  • User Guide - Comprehensive documentation including:
    • Complete API reference with examples
    • CLI command reference
    • Data generator usage
    • Transaction engine details
    • Fraud testing scenarios
    • Framework integration (React, Node.js, Python, Django)
    • Configuration options
    • Troubleshooting guide
  • API Documentation - Interactive Swagger UI (when running)

License

MIT

About

A developer-first banking sandbox for building and testing fintech applications locally.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published