Create SDK backend Open API definitions for FX provider, Payer FSP and Payee FSP

[JaneS321]

As a community memeber interested in the FX use case

I would like to have a well defined API that describes the FX API

So that I can evaluate at a technical level the API functionality, and so that I can decouple work efforts that are building against this API.

Acceptance Criteria

• FX flow SDK backend API and core connector API definitions
• API Snippets for SDK backend
• API Snippets for SDK outbound
• Verfy that the POST /transfers API is generalised to accomodate FX
• Verify that new FX backend API are provided to:
• Request a fx quote on POST/PUT fxQuote
• Reserve a fx transfer on POST/PUT fxTransfer
• Commit an fx transfer on PATCH fxTransfer notification
• Verify that the PUT \Parties are update to include supported currencies and kyc informations
• Verify that there is a call from Mojaloop Connector (SDK) to the core connector that can retrieve the kyc information

Tasks

• SDK Backend
  • Changes for GET /parties response
  • POST /fxQuotes
  • POST /fxTransfers
  • PUT /fxTransfers (For PATCH /fxTransfers status notification)
  • Changes for POST /quotes (If required)
  • Changes for payee side currency conversion if any
• SDK Outbound
  • Changes to POST /transfers API to accomodate FX (FX transfers is not going to be supported on POST /transfers, need to use individual requests like /parties, /services/FXP, /fxQuotes, /quotes, /fxTransfers, /transfers ...etc)
  • Changes for retrieving the kyc information (See Acceptance Criteria)
  • Changes for payee side currency conversion if any
  • Add /services/FXP
  • Add /fxQuotes
  • Add /fxTransfers
  • Changes to GET /parties request and response if any
  • Changes to POST /quotes request and response if any
  • Changes to POST /simpleTransfers request and reponse if any

Pull Requests

• feat(mojaloop/3573): add fx to sdk api-snippets#170

[JaneS321]

Miguel suggested not merging yet