From b478db23d2d5bb3bf5ed3bd79e7647cd338bc9fa Mon Sep 17 00:00:00 2001 From: Venkatachalam Ganapathy Date: Thu, 1 Aug 2024 10:37:39 +0000 Subject: [PATCH] GITBOOK-934: No subject --- SUMMARY.md | 3 +-- .../interfaces.md | 17 ++++++++++++-- .../outwardbankconnector-factory.md | 23 ------------------- .../design/out-apis-to-bank/README.md | 2 +- 4 files changed, 17 insertions(+), 28 deletions(-) rename g2p-bridge/development/{design => design-specifications}/interfaces.md (85%) delete mode 100644 g2p-bridge/development/design-specifications/interfaces/outwardbankconnector-factory.md diff --git a/SUMMARY.md b/SUMMARY.md index 768a9be6..5aae3c59 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -338,8 +338,7 @@ * [Helper Tables](g2p-bridge/development/design/helper-tables/README.md) * [benefit\_program\_configuration](g2p-bridge/development/design-specifications/persistent-objects/benefit\_program.md) * [Config Attributes](g2p-bridge/development/design/config-attributes.md) - * [Interfaces](g2p-bridge/development/design/interfaces.md) - * [OutwardBankConnector Factory](g2p-bridge/development/design-specifications/interfaces/outwardbankconnector-factory.md) + * [Interfaces](g2p-bridge/development/design-specifications/interfaces.md) * [File-based Payment Backend](g2p-bridge/development/file-based-payment-backend.md) * [Tech Guides](g2p-bridge/tech-guides.md) * [📔 User Guides](g2p-bridge/user-guides/README.md) diff --git a/g2p-bridge/development/design/interfaces.md b/g2p-bridge/development/design-specifications/interfaces.md similarity index 85% rename from g2p-bridge/development/design/interfaces.md rename to g2p-bridge/development/design-specifications/interfaces.md index 1db8869b..9df739e1 100644 --- a/g2p-bridge/development/design/interfaces.md +++ b/g2p-bridge/development/design-specifications/interfaces.md @@ -14,8 +14,6 @@ layout: # Interfaces - -

openg2p-g2p-bridge - Technical architecture

Refer to the Technical architecture. As shown in the figure, all outward APIs towards a Sponsor bank are abstracted through an interface. This interface is in the library project - **openg2p-g2p-bridge-bank-connectors** @@ -76,3 +74,18 @@ This API will only acknowledge receipt of a payment instruction. The actual paym | beneficiary\_email\_address | | | beneficiary\_email\_wallet\_provider | | +returns + +| Attribute | Description | +| --------- | ------------------ | +| response | SUCCESS or FAILURE | + +### Bank Connector Factory + +This Factory will return a BankConnector Interface + +This BankConnector class will implement the BankConnector Interface + +The Factory will return the Connector based on the "benefit\_program.sponsor\_bank\_code" + +def get\_bank\_connector (sponsor\_bank\_code : string) -> BankConnectorInterface diff --git a/g2p-bridge/development/design-specifications/interfaces/outwardbankconnector-factory.md b/g2p-bridge/development/design-specifications/interfaces/outwardbankconnector-factory.md deleted file mode 100644 index f969fe2d..00000000 --- a/g2p-bridge/development/design-specifications/interfaces/outwardbankconnector-factory.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: - title: - visible: true - description: - visible: false - tableOfContents: - visible: true - outline: - visible: true - pagination: - visible: true ---- - -# OutwardBankConnector Factory - -This Factory will written a OutwardBankConnector Class Instance - -OutwardBankConnector class will implement the OutwardBankInterface - -The Factory will return the Connector based on the "benefit\_program.sponsor\_bank\_code" - -def get\_outward\_bank\_connector (sponsor\_bank\_code : string) -> OutwardBankInterface diff --git a/g2p-bridge/development/design/out-apis-to-bank/README.md b/g2p-bridge/development/design/out-apis-to-bank/README.md index 903a0f21..441bf7d3 100644 --- a/g2p-bridge/development/design/out-apis-to-bank/README.md +++ b/g2p-bridge/development/design/out-apis-to-bank/README.md @@ -5,5 +5,5 @@ All Outward APIs towards Sponsor Banks 1. will be implemented using an Abstraction Layer of Interfaces - to facilitate integration with sponsor banks using Adaptors & Connectors. 2. will be triggered by Batch jobs -The detailed interface with adaptor and connector - design can be found in the [Interfaces](../interfaces.md) section +The detailed interface with adaptor and connector - design can be found in the [Interfaces](../../design-specifications/interfaces.md) section