FDX Mock Resource Server

Mastercard Developer Hub for FDX APIs documentation: https://developer.mastercard.com/fdx-dev-hub/documentation

Description

The Resource Server is your gateway to secure and standardized financial data access, fully compliant with the latest Financial Data Exchange (FDX) 6.0 standard. This powerful server serves as a central hub, providing authorized users with seamless access to account information, transaction details, payment network data, and more, all designed to meet the needs of banks and financial institutions.

FDX Authorization Server: https://github.com/Mastercard/Fdx-Mock-Auth-Server

Features

• Standardized Endpoints: The resource server implements a set of endpoints following the FDX 6.0 standard, ensuring compatibility and consistency across different financial systems.
• Secure Access: Access to sensitive financial data is secured through authentication and authorization mechanisms, providing controlled access to authorized users only.
• Comprehensive Data: Retrieve various types of financial data including account lists, account details, transaction details, payment network information, and contact details for account holders.
• Scalability: Built to handle large volumes of data requests, the resource server is scalable to accommodate the growing needs of banks and financial institutions.

List of Endpoints

1. Get All Account List: /accounts - Returns all accounts of the consented user.
2. Account Details: /accounts/{account_id} - Returns detailed account information for a specific account ID.
3. Transaction Details: /accounts/{account_id}/transactions - Returns transaction details for a specific account ID.
4. Payment Network Details: /accounts/{account_id}/payment-networks - Returns payment network information for a specific account ID.
5. Contact Details: /accounts/{account_id}/contact - Returns account holder information for a specific account ID.
6. Get All Statements: /accounts/{account_id}/statements - Returns account statements information for a specific account ID.
7. Statements Details: /accounts/{account_id}/statements/{statement_id} - Returns account statements information for a specific statement ID.

Prerequisites

1. An IDE that supports Java 17 or above (e.g., Eclipse, IntelliJ IDEA, Spring Tool Suite).
2. Java installed on your local system.
3. Postman installed on your local system.
4. Docker: Install Docker (Required only for running in docker)

Installation Instructions

1. Download the project from GitHub.
2. Import the project as an existing Maven project in your IDE.
3. Run the application as a Java Application.
4. Once the project is running, download the Postman collection from the resource/postman folder.
5. Import the downloaded Postman collection into Postman.
6. You can now use the imported collection to send requests to the API endpoints and observe the responses.

Usage

1. To run the APIs in the Resource server, you need an authorization token from the FDX Authorization server project. Refer to the README file of the Fdx-Mock-Auth-Server project for details.
2. Update the authorization token in the environment variable authorize_token.
3. Once the valid token is updated in the environment variable, you can hit the API endpoints to get the responses.

Instructions for Building a Docker Image

1. Uncomment the following properties from application.properties so that the resource server can interact with the FDX Authorization server running in the docker container.
   1. mock.auth.issuer.url=http://localhost:8080
   2. mock.auth.server.url=http://fdx.mock.auth.server:8080
2. Navigate into the project's root directory which contains the Dockerfile & build the Docker image using the Docker build command.
   1. "docker build -t fdx-mock-resource-server ."
3. Verify that the Docker image was successfully created. You should see listed in the output.
4. Since both servers will be running on Docker containers, their hosts will be localhost. Each Docker container runs in its own isolated network namespace. The localhost within docker1 refers to docker1 itself, not to docker2. They will not be able to interact with each other.
5. To establish communication between Docker containers (docker1 and docker2) using Docker's port mapping (publishing ports). Create a user-defined bridge network, make sure both containers are connected to the same network, and that they can resolve each other's container names.
6. Commands to create a custom network and run the containers are :
   1. docker network create my-network
   2. docker run -d --network=my-network -p 8080:8080 --name fdx.mock.auth.server fdx-mock-auth-server
   3. docker run -d --network=my-network -p 9090:9090 --name fdx.mock.resource.server fdx-mock-resource-server

License

This is an open-source project and does not have any specific licensing.

Contact Information

For any queries, please post a comment on GitHub. We will look into it and get back to you.