Common Functionality APIs
The Common service acts as the central, always-available engine for maintaining client information within the bank’s infrastructure. It ensures 24/7 consistency and integrity of client data by synchronizing with the core banking system and exposing a unified set of APIs for real-time and batch data operations.
Operating as the single source of truth for client information, this service supports seamless integration across systems and ensures that all connected applications work with accurate, up-to-date client data.
Purpose:
The Client Management APIs in ImPAI provide full lifecycle management for client records. They enable the creation, update, deletion, and retrieval of client details, as well as batch import functionality for onboarding or synchronizing clients from external systems.
Service Categories​
| Category | Purpose |
|---|---|
| Account Management | Get list of available accounts. |
| Transaction Approvals | Four-eyes-approval to approve or reject transactions waiting in Pending for Approval. |
| Get Transaction Information | List transactions and get information about transaction details, history, audit data and related transactions. |
| Get Interface Information | List interface messages and get information about message details. |
| Get Error Information | List error messages and get information about message details. |
Each service category defines consistent API endpoints and follows standardized message formats to ensure reliable integration with external and internal systems.
Where Each API Fits in Operations and Investigation​
The Common APIs do not represent a single business lifecycle of their own. Instead, they provide cross-functional capabilities that support monitoring, investigation, and operational control across multiple payment schemes and shared platform objects.
In practice, these APIs are typically used in four situations:
- Discovery and filtering — list APIs are used to find relevant transactions, errors, interface messages, or accounts based on identifiers, status, or time range etc.
- Detailed inspection — detail APIs are used to retrieve the full information for one specific object once it has been identified.
- Traceability and analysis — history, audit, and related-object APIs are used to understand how an object was processed, how it changed over time, and how it relates to other messages or transactions.
- Operational decision making — approval APIs enable authorized users to approve or reject transactions that require manual authorization under the Four-Eyes principle.
Together, these APIs provide the operational visibility and control layer of ImPAI. They complement the scheme-specific APIs by exposing shared data, processing context, and operational actions across SCT Inst and other supported domains.
List of Available Endpoints​
| Method | Endpoint | Description | Use Cases |
|---|---|---|---|
| POST | /api/common/v1/ | Approve or reject payment transactions that are pending approval. Returns Transaction ID on success. | Act |
| POST | /common_services/ | List available accounts based on given filters. Returns an array of according accounts details. | Find |
| GET | /api/common/v1/ | List error messages based on given filters. Returns an array of according error details. | Find |
| GET | /api/common/v1/ | Get detail information from a specific error message. | Inspect |
| GET | /api/common/v1/ | List interface messages based on given filters. Returns an array of according message details. | Find |
| GET | /api/common/v1/ | Get detail information for a specific interface message. | Inspect |
| GET | /api/common/v1/ | List transactions based on given filters. Returns an array of according transaction details. | Find |
| GET | /api/common/v1/ | Get history detail information for a specific payment transaction. | Trace |
| GET | /api/common/v1/ | Get audit detail information for a specific payment transaction. | Trace |
| GET | /api/common/v1/ | List all related transactions for a specific payment transaction. | Trace |