Behordeun/merchant-registry-svc

The API, frontend, backend codes and all necessary tech related items of merchant payment

Merchant Registry System

This repository is dedicated to the development of a merchant payment system using Mojaloop for seamless merchant transactions. The system allows consumers to pay merchants using mobile wallets with interoperability.

In this current phase, we are focused on implementing the acquiring system and merchant registry, which will serve as an oracle in the payment process.

The Mojaloop's Account Lookup Service will interact with the merchant registry and proceed with the necessary steps in the payment transaction.

For more information on Requirements, Diagrams, and User Stories

Merchant Payment Documentation Repository

Workspaces

• Shared Library
  • Usable Types, Enums, Methods etc..
• Merchant Acquirer Backend Service
  • Backend Service for handling Merchants Informations.
• Merchant Acquirer Frontend
  • Portal for Hub Users, Makers, Checkers to manage and onboarding Merchants.
• Merchant Registry Oracle
  • Will Serve as Oracle for Mojaloop ALS.

Deploying on Docker

• Requirements

  • docker and docker-compose
  • SendGrid API key is required for Email Verification
    • Register at SendGrid and create new API Key at https://app.sendgrid.com/settings/api_keys
    • Create a .env file inside packages/acquirer-backend/ and copy everything from .env.example into it
    • Update the SENDGRID_API_KEY in the .env file with the new API Key obtained from https://app.sendgrid.com/settings/api_keys

• Run

  $ docker-compose up --build

  • Acquirer Frontend should be running at: http://localhost:5173
  • Acquirer Backend should be running at: http://localhost:5555/api/v1/health-check
    • Swagger API Doc should be at: http://localhost:5555/docs
  • Merchant Registry Backend should be running at: http://localhost:8888/health-check
    • Swagger API Doc should be at: http://localhost:8888/docs
  • MinIO S3 Compatible Storage Server is running at http://minio:9000 (Service).
    • To be able to access merchant license document file or QRCode Image,
      • For Linux/Mac, open /etc/hosts with root permission and add this line 127.0.0.1 minio, otherwise minio:9000 link will be unreachable.

Running E2E Testing

Require docker-compose up --build to be running. Use two different test databases for acquirer-backend and registry-oracle services. See ./mysql-init-scripts/init.mysql

• Run

  $ npm run acquirer-backend:test

ERD Design