1.0.2

WIP

Release version: 1.0.2

Release date: 3rd December 2024

Summary

openg2p-g2p-bridge Release 1.0.2 represents a fully functional digital cash disbursement hub. This subsystem accepts disbursement payloads from upstream the PBMS (aka Program MIS) systems. It then interfaces with the downstream Sponsor Bank to initiate the corresponding payment requests. It also accepts account statement from the Sponsor Bank (account statement for the program funding account) and reconciles the payments and failures if any with the original disbursement requests.

To demonstrate the end to end lifecycle of disbursments, this release also ships a Sponsor Bank simulator - called openg2p-g2p-bridge-example-bank. This simulator implements all the APIs expected from a Sponsor Bank. It also generates Account Statement in MT940 format.

Features of this release

The g2p-bridge subsystem has the following microservices and libraries

openg2p-g2p-bridge

openg2p-g2p-bridge-api

Microservice - that implements all the APIs (incoming APIs from upstream PBMS/MIS systems, outgoing APIs into Sponsor Bank and incoming APIs from Sponsor Bank)

openg2p-g2p-bridge-celery-beat-producers

Microservice - All processing in g2p-bridge is handled asynchronously. This asynchronous processing is orchestrated using Celery Beat producers.

openg2p-g2p-bridge-celery-workers

Microservice - The beats produced by the aforementioned beat producers are processed by celery workers. This module implements the necessary workers.

openg2p-g2p-bridge-models

Library - This is a library that contains the pydantic schemas and sqlalchemy models for the g2p-bridge subsystem

openg2p-g2p-bridge-bank-connectors

Library - This library contains the interface definitions for connecting with the sponsor bank. It also contains an implementation of this interface, to connect with Example Bank. Connecting with different sponsor banks during implementations will require custom connectors to be written - on the lines of Example Bank Connector.

openg2p-g2p-bridge-example-bank

openg2p-g2p-bridge-example-bank-api

Microservice - This microservice implements the APIs expected from any Sponsor Bank. This is a Bank Simulator to facilitate end-to-end feature demonstrations of G2P Bridge. This microservice is not expected to be deployed in any Production environment.

openg2p-g2p-bridge-example-bank-celery

Microservice - Handles all asynchrononous processing in the Bank Simulator. It has both the components, viz the beat producers and the workers.

openg2p-g2p-bridge-example-bank-models

Library - Contains the Pydantic schemas and Sqlalchemy models for Example Bank.

Release contents

Release itemLinks

G2P Bridge Source Code & Example Bank Source Code

  • openg2p-g2p-bridge:v1.0.2

  • openg2p-g2p-bridge-example-bank:v1.0.2

  • openg2p-g2p-bridge-deployment:v1.0.2

  • openg2p-g2p-bridge-example-bank-deployment:v1.0.2

  • openg2p-g2p-bridge-test:v1.0.2

Packaged dockers

  • openg2p-g2p-bridge-api:v1.0.2

  • openg2p-g2p-bridge-celery-beat-producers:v1.0.2

  • openg2p-g2p-bridge-celery-workers:v1.0.2

  • openg2p-g2p-bridge-example-bank-api:v1.0.2

  • openg2p-g2p-bridge-example-bank-celery:v1.0.2

Deployment

Testing

  • Test coverage reports

  • Functional Testing

    • Plan

    • Scripts

Documentation

Deploy

To deploy this release on Kubernetes refer to the deployment guide.

Limitations and known issues

  1. Release 1.0.2 has been tested with limited scale. Load testing and performance benchmarks are planned for Release 1.1.0.

  2. REST API security for Incoming APIs into openg2p-g2p-bridge-api needs JWT implementation as described here. This is planned for Release 1.1.0.

  3. REST API security for outgoing APIs in openg2p-g2p-bridge-celery-workers needs JWT implementation as described here. This is planned for Release 1.1.0.

Last updated

Logo

Copyright © 2024 OpenG2P. This work is licensed under Creative Commons Attribution International LicenseCC-BY-4.0 unless otherwise noted.