Introduction

Synergy BOX Suite exposes a list of RESTful services that enable connectivity and interoperability with backend systems, such as core banking systems or third-party services. Using the REST API Synergy BOX can easily integrate with any system that is capable of returning the required response data in the relevant format.

REST stands for Representational state transfer and is the state-of-art architecture style used for internet-based communication between systems. Synergy’s RESTful services are enabled to use both of the standard formats that are commonly supported by systems – JSON (JavaScript Object Notation) and XML (Extensible Markup Language). In the API this is denoted by support for two media types: application/json and application/Synergy BOX RESTful services contain a set of either GET or POST operations – that is, separate services are provided for reading and storing data from and to the backend.

Key Concepts

Synergy BOX builds on top of generic concepts from the core banking systems to ensure ease of use and integration into the banking processes. Additionally, it introduces some new concepts to enrich the core functionality.

Here are some of the important concepts that are used in the solution:

User and customer
Synergy BOX uses the same concept of users and customers as in the core banking system. The user is a person who is registered and logs into the system to perform certain operations. A customer on the other hand may be either a person or a legal entity. The relation is one to many - a single user may be authorized to order banking operations on behalf of several customers.
Document
Any entry, such as a payment order or a declaration, completed in the system is regarded as a document.
Single sign-on
Synergy BOX enables users to operate with the same credentials using both internet and mobile banking. The data is stored independently from the channel, and accessible from both channels if needed.

Scenarios

The services listed in this documentation cover the following main scenarios:

Working with accounts (opening, closing, viewing balance, etc.)
Working with documents (payment orders, declarations)
Reporting (balances)
Customizing dashboards and settings
Third-party integrations:
- Mobile wallet
- Utility payments
- ATMs and branches information

Services

Service SYWSPICKLIST

This service implements a set of operations that are used to retrieve dynamically values that are displayed as options on the screen (for example, in dropdown lists).

Service SYWSPROCESSWS

This service defines operations for authorizing documents. The supported authorization modes are:

Password
Password and token
E-signature

Service SYWSQUERY

This service implements all operations that are used for getting data from the backend system (reports, statements, account information, and so on).

Service SYWSSAVE

This service implements all operations that are used for storing data (payments, declarations, settings, and so on). All operations return a response that indicates the success or failure of the operation and provides details about potential errors.

SynergyGFS