Overview
The Accounts API provides functionality for managing:
- Bank accounts
- Multi-currency support
- Balance tracking
- IBAN management
- Customer accounts
Core Concepts
Account Types
| Type | Description | Features |
|---|
current | Standard checking account | Payments, transfers |
savings | Interest-bearing account | Interest rates |
escrow | Held funds account | Controlled release |
Account Status
| Status | Description | Next States |
|---|
active | Fully operational | inactive, blocked |
inactive | Temporarily disabled | active, closed |
closed | Permanently closed | - |
blocked | Usage restricted | active |
Account Properties
| Field | Description | Required |
|---|
customer_id | Account owner | Yes |
currency | Account currency | Yes |
type | Account type | Yes |
description | Account name | No |
iban | Account number | Auto |
bic | Bank identifier | Auto |
bban | Basic bank account | Auto |
Balance Components
| Type | Description | Usage |
|---|
available | Available funds | Spendable amount |
current | Current balance | Total balance |
pending | Pending transactions | Processing |
holds | Reserved funds | Blocked amount |
| Field | Description |
|---|
purpose | Account purpose |
cost_center | Cost center code |
department | Department name |
project | Project reference |
Validation Rules
Currency Rules
- Valid ISO 4217 code
- Supported by bank
- Matches country rules
IBAN Rules
- Country-specific format
- Valid checksum
- Unique per customer
- Active bank code
Security Requirements
- Customer-scoped access
- Role-based permissions
- Balance visibility rules
- Transaction limits
- Audit logging
See individual endpoint documentation for detailed request/response formats and examples.
