banking-accounts

The Banking Accounts API provides endpoints to create, retrieve, update, delete, and check balances for customer bank accounts. All operations require API key authentication via the X-API-KEY header.

1. Overview

• Base URL: https://demo-node-api.digitalapicraft.com
• Authentication: API Key (X-API-KEY)
• Resource: Bank accounts
• Schema: Uses standard Account object with CUID identifiers
• Supported Operations: Create, list, get by ID, update, delete, get balance

2. API Endpoints

POST /api/banking/accounts

Create a new bank account.

Request Body:

{
  "accountType": "CHECKING",
  "customerId": "cuid_12345",
  "initialBalance": 500.00
}

Response:

201 – Account created successfully.

GET /api/banking/accounts

Retrieve a list of all accounts.

Response:

200 – Array of Account objects.

GET /api/banking/accounts/{id}

Fetch account details using its unique ID.

Path Parameter:

id: string (cuid)

Response:

200 – Account details.

PUT /api/banking/accounts/{id}

Update the account type or balance.

Request Body:

{
  "accountType": "SAVINGS",
  "balance": 1200.00
}

Response:

200 – Account updated successfully.

DELETE /api/banking/accounts/{id}

Delete an account permanently.

Response:

204 – Account deleted successfully.

GET /api/banking/accounts/{id}/balance

Retrieve only the balance of an account.

Response:

200 – Balance value.

3. Account Schema

The Account object contains the following fields:

{
  "id": "cuid_xxxxxx",
  "accountNumber": "ACC1234567",
  "accountType": "CHECKING",
  "balance": 500.00,
  "customerId": "cuid_abc123",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-05T10:30:00Z"
}

4. Notes & Recommendations

• Add validation rules for minimum balance and allowed account types.
• Introduce filtering and pagination for the GET /accounts endpoint.
• Include standardized error response formats for each endpoint.