openclaw-banking-agent-os

JavaScript/TypeScript SDK for Banking Agent OS

Installation

npm install openclaw-banking-agent-os
# or
yarn add openclaw-banking-agent-os
# or
pnpm add openclaw-banking-agent-os

Quick Start

import { BankingAgentClient, AccountType, TransactionType } from 'openclaw-banking-agent-os';

// Initialize client
const client = new BankingAgentClient({
  baseURL: 'http://localhost:8000',
  apiKey: 'your-api-key' // optional
});

// Create an account
const account = await client.accounts.create({
  user_id: 'user_123',
  account_type: AccountType.CHECKING,
  currency: 'USD',
  initial_balance: 1000.00
});

// Make a transfer
const transaction = await client.transactions.create({
  from_account_id: account.id,
  to_account_id: 'other_account_id',
  amount: 100.00,
  transaction_type: TransactionType.TRANSFER,
  description: 'Payment'
});

// AI customer support
const response = await client.ai.chat('How do I check my balance?');
console.log(response);

// Risk assessment
const riskResult = await client.risk.assess({
  from_account_id: account.id,
  amount: 5000.00,
  transaction_type: TransactionType.WITHDRAWAL
});
console.log(riskResult);

API Reference

Client Configuration

const client = new BankingAgentClient({
  baseURL: 'http://localhost:8000',  // API base URL
  apiKey: 'your-api-key',            // Optional API key
  timeout: 30000                      // Request timeout (ms)
});

Accounts

// Create account
const account = await client.accounts.create({
  user_id: string,
  account_type: AccountType,
  currency?: string,
  initial_balance?: number
});

// Get account
const account = await client.accounts.get(accountId);

// Get user's accounts
const accounts = await client.accounts.listByUser(userId);

Transactions

// Create transaction
const transaction = await client.transactions.create({
  from_account_id?: string,
  to_account_id?: string,
  amount: number,
  currency?: string,
  transaction_type: TransactionType,
  description?: string
});

// Get transaction
const transaction = await client.transactions.get(transactionId);

// Get account transactions
const transactions = await client.transactions.listByAccount(accountId, limit);

AI Service

// Chat
const response = await client.ai.chat(message, conversationHistory);

// Analyze transaction
const analysis = await client.ai.analyzeTransaction(transactionData);

// Get financial advice
const advice = await client.ai.getFinancialAdvice(userProfile, accountData);

// Detect anomalies
const anomalies = await client.ai.detectAnomalies(transactions);

Risk Control

// Assess risk
const result = await client.risk.assess({
  from_account_id: string,
  to_account_id?: string,
  amount: number,
  transaction_type: TransactionType
});

// Get risk report
const report = await client.risk.getReport(accountId);

TypeScript Support

This SDK is written in TypeScript and provides full type definitions.

import {
  BankingAgentClient,
  Account,
  Transaction,
  AccountType,
  TransactionType,
  TransactionStatus
} from 'openclaw-banking-agent-os';

Error Handling

try {
  const transaction = await client.transactions.create({...});
} catch (error) {
  if (error.response) {
    // API error response
    console.error('API Error:', error.response.data);
  } else if (error.request) {
    // Network error
    console.error('Network Error:', error.message);
  } else {
    console.error('Error:', error.message);
  }
}

License

MIT

Support

• Documentation: https://github.com/openclaw/banking-agent-os
• Issues: https://github.com/openclaw/banking-agent-os/issues
• ClawHub: https://clawhub.ai/openclaw/banking-agent-os