Status Check API

Overview

Monitor the status of all Connected Banking operations including payouts, statement fetches, balance checks, and VAM operations with comprehensive tracking and reporting.

Key Features (Planned)

• Real-time Status: Live transaction and operation tracking
• Comprehensive Monitoring: All API operation status
• Historical Tracking: Complete operation history
• Detailed Reporting: In-depth status information
• Bulk Status Check: Multiple operation status retrieval
• API Health Monitoring: Service availability tracking

Expected API Endpoints

Transaction Status

GET /api/connected-banking/v1/status/transaction

Check status of specific transaction by ID.

Operation Status

GET /api/connected-banking/v1/status/operation

Check status of API operations (balance check, statement fetch, etc.).

Bulk Status Check

POST /api/connected-banking/v1/status/bulk

Check status of multiple transactions/operations.

API Health Status

GET /api/connected-banking/v1/status/health

Monitor overall API health and availability.

Expected Request Parameters

Single Transaction Status

{
  "transaction_id": "CBP123456789",
  "type": "payout"
}

Operation Status

{
  "operation_id": "OPR987654321",
  "operation_type": "balance_check"
}

Bulk Status Check

{
  "requests": [
    {
      "id": "CBP123456789",
      "type": "payout"
    },
    {
      "id": "OPR987654321",
      "type": "statement_fetch"
    }
  ]
}

Expected Response Format

Transaction Status Response

{
  "status": "success",
  "data": {
    "transaction_id": "CBP123456789",
    "type": "payout",
    "status": "COMPLETED",
    "status_message": "Payout completed successfully",
    "amount": "1000.00",
    "beneficiary_account": "1234567890",
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-15T10:35:00Z",
    "bank_reference": "BNK789456123"
  }
}

API Health Response

{
  "status": "operational",
  "services": {
    "payout_api": {
      "status": "operational",
      "uptime": "99.99%",
      "response_time": "150ms"
    },
    "statement_fetch": {
      "status": "operational",
      "uptime": "99.95%",
      "response_time": "200ms"
    },
    "balance_check": {
      "status": "operational",
      "uptime": "99.99%",
      "response_time": "100ms"
    }
  }
}

Status Types

Transaction Statuses

• INITIATED: Transaction started
• PROCESSING: Transaction in progress
• COMPLETED: Transaction successful
• FAILED: Transaction failed
• CANCELLED: Transaction cancelled

Operation Statuses

• STARTED: Operation initiated
• IN_PROGRESS: Operation processing
• COMPLETED: Operation successful
• FAILED: Operation failed
• TIMEOUT: Operation timed out

API Health Statuses

• OPERATIONAL: Service fully operational
• DEGRADED: Service experiencing issues
• PARTIAL_OUTAGE: Some services affected
• MAJOR_OUTAGE: Significant service disruption

Use Cases

Transaction Monitoring

• Payout Tracking: Real-time payout status updates
• Operation Progress: Monitor API operation completion
• Error Detection: Identify and resolve issues quickly

System Monitoring

• API Health: Monitor service availability
• Performance Tracking: Response time monitoring
• Uptime Monitoring: Service reliability tracking

Business Intelligence

• Success Rates: Transaction completion analytics
• Performance Metrics: API operation statistics
• Trend Analysis: Historical performance trends

Monitoring Features

Real-time Updates

• Live Status: Instant status updates
• Push Notifications: Real-time alerts
• Webhook Integration: Status change notifications

Historical Data

• Status History: Complete operation timeline
• Performance Metrics: Historical analytics
• Trend Analysis: Long-term performance tracking