Reference Java implementation of PSD2 XS2A Interface of Berlin Group
With PSD2 (Directive (EU) 2015/2366 of the European Parliament and of the Council on Payment Services in the Internal Market, published 25 November 2016) the European Union has published a new directive on payment services in the internal market. Among others PSD2 contains regulations on new services to be operated by so called Third Party Payment Service Providers (TPP) on behalf of a Payment Service User (PSU).
These new services are:
- Payment Initiation Service (PIS) to be operated by a Payment Initiation Service Provider (PISP) TPP as defined by article 66 of [PSD2],
- Account Information Service (AIS) to be operated by an Account Information Service Provider (AISP) TPP as defined by article 67 of [PSD2], and
- Confirmation on the Availability of Funds Service (FCS) to be used by a Payment Instrument Issuing Service Provider (PIISP) TPP as defined by article 65 of [PSD2].
To implement these new services (subject to PSU consent) a TPP needs to access the account of the PSU. The account is usually managed by another PSP called the Account Servicing Payment Service Provider (ASPSP). To support the TPP in accessing the accounts managed by an ASPSP, each ASPSP has to provide an "access to account interface" (XS2A interface). Responsibilities and rights of TPP and ASPSP concerning the interaction at the XS2A interface are defined and regulated by PSD2.
Who we are
adorsys is a company who works ever since the very beginning of PSD2 with its requirements and implicit tasks. We help banks to be PSD2 complaint (technical and legal terms). To speed up the process we provide this open source XS2A interface, specified by Berlin Group, that can be connected to your middleware system. You can check your readiness for PSD2 Compliance and other information via our Web-site.
Features of adorsys/XS2A
Current supported version of NextGenPSD2 XS2A API is 1.3.4. You can check out our Swagger API yaml file.
XS2A-impl is an implemetation of NextGenPSD2 XS2A Interface of Berlin Group. All mandatory API endpoints defined in Berlin Group specification are implemented.
Swagger documentation is presented for all REST API modules: XS2A, ASPSP-Server, Consent Management System.
Consent Management System is the system intended to store and manage consents given by PSU to corresponding TPPs. This system is developed for ASPSPs that don't have their own Consents Management System.
ASPSP-Profile is REST API Module to store and read ASPSP-specific configurations for XS2A-features. The behavior of XS2A can change depending on the stored values, for example, using different SCA approaches.
Logging System is the system that allows ASPSP operators to track all logically related calls in XS2A, starting from the requests from TPP to the final responses to TPP. This module is not in the Berlin Group specification.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Java, version 1.8 - The main language of implementation
- Maven, version 3.0 - Dependency Management
- Spring Boot - Spring boot as core Java framework
Dockerfiles provided in the project allow to put the build artifacts into a docker images. Those images are to be configured through your environment (documentation follows) to interact properly.
More details see in instruction
We are migrating our documentation pages to our new Documentation site.
There are already available:
- Architecture documentation
- Use-cases diagrams
- Release policy
- Release notes
Development and contributing
Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.
Testing API with Postman json collections
For testing API of xs2a it is used Postman https://www.getpostman.com/ Environment jsons with global parameter’s sets and Collections of jsons for imitation of processes flows are stored in /scripts/tests/postman folder. To import Postman collections and environments follow next steps:
Download Postman jsons with collections and environments to your local machine.
Open Postman, press button “Import”.
Choose “Import file” to import one json or “Import folder” to import all jsons within the folder, then press button “Choose Files” or “Choose Folders” and open necessary files/folders.
To change settings of environments - go to “Manage Environments”, press the environment name and change variables.
To start testing with Postman collections it is necessary to have all services running.
Authors & Contact
See also the list of contributors who participated in this project.
For commercial support please contact adorsys Team.
This project is licensed under the Apache License version 2.0 - see the LICENSE file for details