Settlements - V2 Design

[NicoDuvenage]

Request:

Discuss proposed database changes catering for the V2 of the Settlements Functionality, as well as the amended Sequence Diagrams

Artifacts:

• [x] Artifact to consider [@ggrg] - please refer to Main artifcats section below

Decision(s):

• [x] closeSettlementWindow requested changes
  • [x] extend DB TRANSACTION title to describe transactions
  • [x] add PROCESSING and FAILED window states
  • [x] add SettlementWindowHandler to enable asynchronous window closure
• [x] createSettlement requested changes
  • [x] verify current step 8 in respect to the above changes
  • [x] add settlement content info to the response
• [x] updateSettlementById
  • [x] response sample approved - #yellow colour to be applied

Follow-up:

• N/A

Dependencies:

• N/A

Accountability:

• Owner: @ggrg

Notes:

DA review session for the DB schema changes in relation to the ongoing settlements upgrade to v2.

Enhancements

Proposed enhancements are included in the FSD: oss-settlement-fsd.html

Database changes:

• Story: https://github.com/mojaloop/project/issues/1093
• Pull request: https://github.com/mojaloop/documentation/pull/144

Sequence diagrams (in scope of Settlement by Currency epic):

• Story: https://github.com/mojaloop/project/issues/1094
• Pull request: https://github.com/mojaloop/documentation/pull/148

Other settlement related sequence diagrams:

• Story: https://github.com/mojaloop/project/issues/1105
• Pull request: https://github.com/mojaloop/documentation/pull/150

Main artifacts:

• Base DB Schema
• [x] Proposed DB Schema (after PR merge available here)
• [x] closeSettlementWindow sequence diagram
• [x] createSettlement sequence diagram
• [x] updateSettlementById sequence diagram
• getSettlementWindowById sequence diagram
• abortSettlementById sequence diagram
• getSettlementsByParams sequence diagram
• getSettlementBySPA sequence diagram