bank-transaction-extractor

Bank Transaction Extractor

A Node.js library for automated transaction extraction from online banking portals with currency conversion support. Designed for financial institutions that use web-based interfaces with CAPTCHA verification.

⚠️ Important Legal Disclaimer

This library is not affiliated, associated, authorized, endorsed by, or in any way officially connected with any financial institution. It is provided "as-is" without any warranties or guarantees. Users are responsible for:

• Ensuring compliance with all applicable data protection laws and regulations
• Obtaining necessary permissions for data access and processing
• Securely handling and storing any extracted financial data
• Verifying the accuracy of extracted data
• Using the library in accordance with their banking institution's terms of service

This library is intended for personal finance management only and should not be used to alter, falsify, or misrepresent financial data.

Data Protection & Security Guidelines

• Data Privacy:

  • All processing occurs locally on your machine
  • No data is transmitted to external servers
  • Temporary files are automatically cleared
  • Implements secure data handling practices

• Security Best Practices:

  • Uses secure HTTPS connections
  • Implements robust authentication
  • Regular security updates
  • Follows standard financial security protocols

Compatibility

This library is compatible with online banking portals that:

• Implement CAPTCHA verification
• Provide CSV/Excel export functionality
• Display transaction history in tabular format
• Support standard date formats (DD/MM/YYYY)

Features

• Automated login with CAPTCHA solving
• Transaction extraction for specified accounts
• Multi-currency support with conversion
• TypeScript support
• Automated cleanup of temporary files

Installation

npm install bank-transaction-extractor

Environment Variables

Create a .env file in your project root with the required variables. You can find a template with all required variables in the .env.example file.

Usage

Basic Usage - Get Transactions

import { getTransactions, Currency } from 'bank-transaction-extractor';

async function main() {
  try {
    const transactions = await getTransactions({
      username: 'your-username',
      password: 'your-password',
      accountNumber: 'your-account-number'
    });
    
    console.log('Transactions:', transactions);
  } catch (error) {
    console.error('Error:', error);
  }
}

Get Transactions with Currency Conversion

import { getTransactions, Currency } from 'bank-transaction-extractor';

async function main() {
  try {
    const transactions = await getTransactions({
      username: 'your-username',
      password: 'your-password',
      accountNumber: 'your-account-number',
      targetCurrency: Currency.USD, // Optional: Target currency
      exchangeRate: 0.032 // Optional: Exchange rate (EGP to USD in this example)
    });
    
    console.log('Converted Transactions:', transactions);
  } catch (error) {
    console.error('Error:', error);
  }
}

Transaction Object Structure

Each transaction object contains:

interface BankTransaction {
  transactionDate: string;
  valueDate: string;
  description: string;
  debitAmount: number;
  creditAmount: number;
  balance: number;
  reference: string;
  currency: string;
}

Error Handling

The library throws errors for various scenarios:

• Invalid credentials
• CAPTCHA solving failures
• Network issues
• Missing configuration

Always wrap your calls in try-catch blocks for proper error handling.

Contributing

• Fork the repository
• Create your feature branch (git checkout -b feature/amazing-feature)
• Commit your changes (git commit -m 'Add some amazing feature')
• Push to the branch (git push origin feature/amazing-feature)
• Open a Pull Request

License

MIT License - see the LICENSE file for details