Feature to support final notification to a Payee FSP, a PATCH call

[elnyry-sam-k]

Goal:

As a Payee FSP
I want to receive a notification of finalization of a transfer
so that I can use it to make informed decisions on down stream release of funds / payments

As a Hub
I want the option to notify Payee of a finalized transfer
so that the Payee FSP has more information regarding the final status of a transfer at the Hub

Note:

• Issue from mojaloop-specification here: Change Request: Possibility to notify Payee FSP on successful commit in Switch  mojaloop-specification#29
• Issue to access version v1.1 of the API Definition and Swagger: Tracking item: List of changes to be made in Version 1.1 of the API Definition mojaloop-specification#52 (comment)

Tasks:

• Review API Spec and Swagger v1.1 for this change
• Design and update sequence diagrams
• Present designs to the DA (though already reviewed, discussed and approved) created follow up story Feature to support final notification to a Payee FSP, a PATCH call - continue #1462
• Implementation to support the PATCH notification and use the new Swagger v1.1
  • ml-api-adapter
    • PUT transfer route to support request for
    • notif handler
  • central-services-shared
  • central-ledger
    • fulfil handler
    • position handler
  • simulator to accept PATCH
  • sdk-standard-components created follow up story Feature to support final notification to a Payee FSP, a PATCH call - continue #1462
  • sdk-scheme-adapter (update swagger) created follow up story Feature to support final notification to a Payee FSP, a PATCH call - continue #1462
  • mojaloop-simulator created follow up story Feature to support final notification to a Payee FSP, a PATCH call - continue #1462
• Update all end-points needed to use v1.1 in the versions (Accept, content-type)
• register header validation plugin into ml-api-adapter
• Unit, integration tests
• Add special fsp in legacy simulator to send RESERVE and accept a PATCH
• Update postman collections, etc for QA

Acceptance Criteria:

• Designs are up-to date
• Unit Tests pass
• Integration Tests pass
• Code Style & Coverage meets standards
• Changes made to config (default.json) are broadcast to team and follow-up tasks added to update helm charts and other deployment config.
• A notification to a Payee FSP, via a PATCH call on finalization of a transfer can be made if requested by the Payee FSP

Pull Requests:

• Feature/#1334 patch request notif central-services-shared#232
• Feature/#1334 patch request notif central-ledger#751
• Feature/#1334 patch request notif ml-api-adapter#444
• added PATCH at allowed methods for /transfers/{ID} route simulator#197
• Feature/#1334 patch request notif postman#136
• Feature/#1334 patch request notif documentation#230

Follow-up:

• Feature to support final notification to a Payee FSP, a PATCH call - continue #1462

Dependencies:

• N/A

Accountability:

• Owner: TBC
• QA/Review: @elnyry

[elnyry-sam-k]

@vgenev latest Swagger here: https://github.com/mojaloop/mojaloop-specification/tree/master/documents/v1.1-document-set

[elnyry-sam-k]

Thanks @vgenev