@mojaloop/api-snippets 17.3.0-snapshot.0 → 17.4.0

package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml

@@ -1,24 +1,16 @@
 openapi: 3.0.1
 info:
   title: Mojaloop SDK Backend API
-  description: >
+  description: |
     API specification for the SDK Backend API.
 
+    To be implemented by the Digital Financial Service Provider (DFSP) to work in tandem with the Mojaloop SDK (`mojaloop/sdk-scheme-adapter`).
 
-    To be implemented by the Digital Financial Service Provider (DFSP) to work
-    in tandem with the Mojaloop SDK (`mojaloop/sdk-scheme-adapter`).
+    This API is not to be confused with the Mojaloop SDK's Inbound or Outbound API.
 
+    TODO: More explanation and links about the SDK adapter's Inbound and Outbound API.
 
-    This API is not to be confused with the Mojaloop SDK's Inbound or Outbound
-    API.
-
-
-    TODO: More explanation and links about the SDK adapter's Inbound and
-    Outbound API.
-
-
-    **Note on terminology:** The term "Switch" is equal to the term "Hub", and
-    the term "FSP" is equal to the term "DFSP".
+    **Note on terminology:** The term "Switch" is equal to the term "Hub", and the term "FSP" is equal to the term "DFSP".
   license:
     name: Apache License Version 2.0, January 2004
     url: http://www.apache.org/licenses/
@@ -72,20 +64,12 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-      summary: >-
-        Requests information relating to a bulk quote identified by the
-        specified identifier value.
+      summary: Requests information relating to a bulk quote identified by the specified identifier value.
       tags:
         - BulkQuotes
   /bulkTransactions/{bulkTransactionId}:
     put:
-      description: >-
-        The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to
-        amend information regarding a bulk transaction, i.e. when
-        autoAcceptParty or autoAcceptQuote  is false then the payer need to
-        provide confirmation to proceed with further processing of the request.
-        The `{bulkTransactionId}` in the URI should contain the
-        `bulkTransactionId` that was used for the creation of the bulk transfer.
+      description: The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote  is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
       operationId: BackendBulkTransactionsPut
       parameters:
         - $ref: '#/components/parameters/bulkTransactionId'
@@ -106,9 +90,7 @@ paths:
         - BulkTransactionsPut
   /requestToPay/{transactionRequestId}:
     put:
-      description: >-
-        It is used to notify the DFSP backend about the status of the
-        requestToPayTransfer.
+      description: It is used to notify the DFSP backend about the status of the requestToPayTransfer.
       operationId: RequestToPayPut
       parameters:
         - $ref: '#/components/parameters/transactionRequestId'
@@ -147,9 +129,7 @@ paths:
           $ref: '#/components/responses/400'
         '500':
           $ref: '#/components/responses/500'
-      summary: >-
-        Execute bulk transfer of funds from an external account to internal
-        accounts.
+      summary: Execute bulk transfer of funds from an external account to internal accounts.
       tags:
         - BulkTransfers
   /bulkTransfers/{idValue}:
@@ -170,9 +150,7 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-      summary: >-
-        Requests information relating to a bulk transfer identified by the
-        specified identifier value.
+      summary: Requests information relating to a bulk transfer identified by the specified identifier value.
       tags:
         - BulkTransfers
   /otp/{transactionRequestId}:
@@ -198,10 +176,7 @@ paths:
         - OTP
   /participants/{idType}/{idValue}:
     get:
-      description: >-
-        The HTTP request `GET /participants/{idType}/{idValue}` is used to find
-        out in which FSP the requested party, defined by `{idType}` and
-        `{idValue}`, is located.
+      description: The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located.
       operationId: BackendParticipantsGetByTypeAndID
       parameters:
         - $ref: '#/components/parameters/idType'
@@ -219,17 +194,12 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-      summary: >-
-        Asks for the identifier (fspId) of the scheme participant (FSP) that can
-        handle transfers for the specified identifier type and value.
+      summary: Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
       tags:
         - Participants
   /participants/{idType}/{idValue}/{idSubValue}:
     get:
-      description: >-
-        The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is
-        used to find out in which FSP the requested party, defined by
-        `{idType}`, `{idValue}` and `{idSubValue}` is located.
+      description: The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located.
       operationId: BackendParticipantsGetByTypeIDAndSubId
       parameters:
         - $ref: '#/components/parameters/idType'
@@ -248,17 +218,12 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-      summary: >-
-        Asks for the identifier (fspId) of the scheme participant (FSP) that can
-        handle transfers for the specified identifier type and value.
+      summary: Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
       tags:
         - Participants
   /parties/{idType}/{idValue}:
     get:
-      description: >-
-        The HTTP request `GET /parties/{idType}/{idValue}` is used to look up
-        information regarding the requested transfer party, identified by
-        `{idType}` and `{idValue}`.
+      description: The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`.
       operationId: BackendPartiesGetByTypeAndID
       parameters:
         - $ref: '#/components/parameters/idType'
@@ -276,17 +241,12 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-      summary: >-
-        Requests information relating to a transfer party identified by the
-        specified identifier type and value.
+      summary: Requests information relating to a transfer party identified by the specified identifier type and value.
       tags:
         - Parties
   /parties/{idType}/{idValue}/{idSubValue}:
     get:
-      description: >-
-        The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used
-        to look up information regarding the requested transfer party,
-        identified by `{idType}`, `{idValue}` and `{idSubValue}`.
+      description: The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`.
       operationId: BackendPartiesGetByTypeIdAndSubId
       parameters:
         - $ref: '#/components/parameters/idType'
@@ -305,16 +265,12 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-      summary: >-
-        Requests information relating to a transfer party identified by the
-        specified identifier type, value and subId value.
+      summary: Requests information relating to a transfer party identified by the specified identifier type, value and subId value.
       tags:
         - Parties
   /quoterequests:
     post:
-      description: >-
-        The HTTP request `POST /quoterequests` is used to request the creation
-        of a quote for the provided financial transaction.
+      description: The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction.
       operationId: BackendQuoteRequest
       requestBody:
         content:
@@ -361,9 +317,7 @@ paths:
         - TransactionRequest
   /transfers:
     post:
-      description: >-
-        The HTTP request `POST /transfers` is used to request the creation of a
-        transfer for the transfer party.
+      description: The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party.
       operationId: BackendTransfersPost
       requestBody:
         content:
@@ -387,11 +341,7 @@ paths:
         - Transfers
   /transfers/{transferId}:
     get:
-      description: >-
-        The HTTP request `GET /transfers/{transferId}` is used to get
-        information regarding a transfer created or requested earlier. The
-        `{transferId}` in the URI should contain the `transferId` that was used
-        for the creation of the transfer.
+      description: The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
       operationId: BackendTransfersGet
       parameters:
         - $ref: '#/components/parameters/transferId'
@@ -408,9 +358,7 @@ paths:
       tags:
         - Transfers
     put:
-      description: >-
-        The HTTP request `PUT /transfers/{transferId}` is used to receive
-        notification for transfer being fulfiled when the FSP is a Payee.
+      description: The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee.
       operationId: BackendTransfersPut
       parameters:
         - $ref: '#/components/parameters/transferId'
@@ -431,9 +379,7 @@ paths:
 components:
   parameters:
     idSubValue:
-      description: >-
-        A sub-identifier of the party identifier, or a sub-type of the party
-        identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
+      description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
       in: path
       name: idSubValue
       required: true
@@ -471,9 +417,7 @@ components:
       required: true
       schema:
         $ref: '#/components/schemas/CorrelationId'
-      description: >-
-        Identifier of the bulk transaction to continue as returned in the
-        response to a `POST /bulkTransaction` request.
+      description: Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request.
   responses:
     '400':
       content:
@@ -482,9 +426,7 @@ components:
             $ref: '#/components/schemas/errorResponse'
       description: Malformed or missing required headers or parameters.
     '404':
-      description: >-
-        The party specified by the provided identifier type and value is not
-        known to the server.
+      description: The party specified by the provided identifier type and value is not known to the server.
     '500':
       content:
         application/json:
@@ -495,8 +437,7 @@ components:
     DateOfBirth:
       title: DateofBirth (type Date)
       type: string
-      pattern: >-
-        ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
+      pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
       description: Date of Birth of the Party.
       example: '1966-06-16'
     FirstName:
@@ -504,9 +445,7 @@ components:
       type: string
       minLength: 1
       maxLength: 128
-      pattern: >-
-        ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
-        .,''-]{1,128}$
+      pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
       description: First name of the Party (Name Type).
       example: Henrik
     FspId:
@@ -645,27 +584,20 @@ components:
       type: string
       minLength: 1
       maxLength: 128
-      pattern: >-
-        ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
-        .,''-]{1,128}$
+      pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
       description: Last name of the Party (Name Type).
       example: Karlsson
     MerchantClassificationCode:
       title: MerchantClassificationCode
       type: string
       pattern: ^[\d]{1,4}$
-      description: >-
-        A limited set of pre-defined numbers. This list would be a limited set
-        of numbers identifying a set of popular merchant types like School Fees,
-        Pubs and Restaurants, Groceries, etc.
+      description: A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.
     MiddleName:
       title: MiddleName
       type: string
       minLength: 1
       maxLength: 128
-      pattern: >-
-        ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
-        .,''-]{1,128}$
+      pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
       description: Middle name of the Party (Name Type).
       example: Johannes
     amountCurrency:
@@ -686,8 +618,7 @@ components:
       type: string
     bulkQuoteId:
       description: A Mojaloop API bulk quote identifier (UUID).
-      pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     bulkQuoteRequest:
       description: A request for a bulk quote.
@@ -719,9 +650,7 @@ components:
         expiration:
           $ref: '#/components/schemas/timestamp'
         individualQuoteResults:
-          description: >-
-            Fees for each individual transaction, if any of them are charged per
-            transaction.
+          description: Fees for each individual transaction, if any of them are charged per transaction.
           items:
             oneOf:
               - $ref: '#/components/schemas/IndividualQuoteResultSuccess'
@@ -735,8 +664,7 @@ components:
       type: object
     bulkTransferId:
       description: A Mojaloop API transfer identifier (UUID).
-      pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     bulkTransferRequest:
       properties:
@@ -761,9 +689,7 @@ components:
         bulkTransferId:
           $ref: '#/components/schemas/bulkTransferId'
         homeTransactionId:
-          description: >-
-            Transaction ID from the DFSP backend, used to reconcile transactions
-            between the switch and DFSP backend systems.
+          description: Transaction ID from the DFSP backend, used to reconcile transactions between the switch and DFSP backend systems.
           type: string
         individualTransferResults:
           items:
@@ -945,18 +871,11 @@ components:
       type: string
     dateOfBirth:
       description: Date of birth in the form YYYY-MM-DD.
-      pattern: >-
-        ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
+      pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
       type: string
     errorCode:
-      description: >
-        The API data type errorCode is a JSON String of four characters,
-        consisting of digits only. Negative numbers are not allowed. A leading
-        zero is not allowed. Each error code in the API is a four-digit number,
-        for example, 1234, where the first number (1 in the example) represents
-        the high-level error category, the second number (2 in the example)
-        represents the low-level error category, and the last two numbers (34 in
-        the example) represents the specific error.
+      description: |
+        The API data type errorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represents the specific error.
       pattern: ^[1-9]\d{3}$
       title: ErrorCode
       type: string
@@ -986,13 +905,9 @@ components:
           description: Error message text
           type: string
         statusCode:
-          description: >
-            Backend error code from FSP. Ideally, statusCode is FSPIOP
-            conforming. SDK will use status code to retrieve an FSPIOP error
-            with the same code.
-
-            Otherwise, a suitable generic FSPIOP will be used with the
-            errorResponse in the FSPIOP error message.
+          description: |
+            Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.
+            Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
           type: string
       type: object
     extensionItem:
@@ -1101,14 +1016,10 @@ components:
       title: TransfersIDPatchResponse
       type: object
     generalError:
-      description: >-
-        This object may represent a number of different error object types and
-        so its properties may vary significantly.
+      description: This object may represent a number of different error object types and so its properties may vary significantly.
       type: object
     geoCode:
-      description: >-
-        Indicates the geographic location from where the transaction was
-        initiated.
+      description: Indicates the geographic location from where the transaction was initiated.
       properties:
         latitude:
           $ref: '#/components/schemas/latitude'
@@ -1175,18 +1086,12 @@ components:
         - DEVICE
       type: string
     latitude:
-      description: >-
-        The API data type Latitude is a JSON String in a lexical format that is
-        restricted by a regular expression for interoperability reasons.
-      pattern: >-
-        ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
+      description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
+      pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
       type: string
     longitude:
-      description: >-
-        The API data type Longitude is a JSON String in a lexical format that is
-        restricted by a regular expression for interoperability reasons.
-      pattern: >-
-        ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
+      description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
+      pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
       type: string
     money:
       pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
@@ -1213,17 +1118,14 @@ components:
       type: string
     quoteId:
       description: A Mojaloop API quote identifier (UUID).
-      pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     quoteRequest:
       description: A request for a quote for transfer from the DFSP backend.
       properties:
         homeR2PTransactionId:
           type: string
-          description: >-
-            Linked homeR2PTransactionId which was generated as part of POST
-            /requestToPay to SDK incase of requestToPay transfer.
+          description: Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer.
         amount:
           $ref: '#/components/schemas/money'
         amountType:
@@ -1316,15 +1218,11 @@ components:
       type: string
     timestamp:
       description: An ISO-8601 formatted timestamp.
-      pattern: >-
-        ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
+      pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
       type: string
     transactionId:
-      description: >-
-        ID of the transaction, the ID is decided by the Payer FSP during the
-        creation of the quote.
-      pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transactionRequest:
       description: A request for a pull based transfer.
@@ -1370,17 +1268,14 @@ components:
       type: object
     transactionRequestId:
       description: A Mojaloop API transaction request identifier (UUID).
-      pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transactionRequestResponse:
       description: A response to a request for a quote.
       properties:
         homeR2PTransactionId:
           type: string
-          description: >-
-            Transaction ID from the DFSP backend, used to reconcile transactions
-            between the Switch and DFSP backend systems.
+          description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
         transactionId:
           $ref: '#/components/schemas/transactionId'
         transactionRequestState:
@@ -1397,9 +1292,7 @@ components:
         - REJECTED
       type: string
     transactionSubScenario:
-      description: >-
-        Possible sub-scenario, defined locally within the scheme (UndefinedEnum
-        Type). Based on FSPIOP TransactionSubScenario.
+      description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
       example: LOCALLY_DEFINED_SUBSCENARIO
       pattern: ^[A-Z_]{1,32}$
       title: transactionSubScenario
@@ -1439,9 +1332,7 @@ components:
         from:
           $ref: '#/components/schemas/transferParty'
         homeTransactionId:
-          description: >-
-            Transaction ID from the DFSP backend, used to reconcile transactions
-            between the Switch and DFSP backend systems.
+          description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
           type: string
         note:
           maxLength: 128
@@ -1469,8 +1360,7 @@ components:
       type: object
     transferId:
       description: A Mojaloop API transfer identifier (UUID).
-      pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
     transferParty:
       properties:
@@ -1498,9 +1388,7 @@ components:
           description: Party last name.
           type: string
         merchantClassificationCode:
-          description: >-
-            Up to 4 digits specifying the sender's merchant classification, if
-            known and applicable.
+          description: Up to 4 digits specifying the sender's merchant classification, if known and applicable.
           type: string
         middleName:
           description: Party middle name.
@@ -1515,9 +1403,7 @@ components:
       properties:
         homeR2PTransactionId:
           type: string
-          description: >-
-            Linked homeR2PTransactionId which was generated as part of POST
-            /requestToPay to SDK incase of requestToPay transfer.
+          description: Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer.
         amount:
           $ref: '#/components/schemas/money'
         amountType:
@@ -1568,9 +1454,7 @@ components:
         fulfilment:
           $ref: '#/components/schemas/IlpFulfilment'
         homeTransactionId:
-          description: >-
-            Transaction ID from the DFSP backend, used to reconcile transactions
-            between the Switch and DFSP backend systems.
+          description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
           type: string
         transferState:
           $ref: '#/components/schemas/transferState'
@@ -1578,12 +1462,8 @@ components:
         - homeTransactionId
       type: object
     transferState:
-      description: >
-        Below are the allowed values for the enumeration - RECEIVED DFSP has
-        received the transfer. - RESERVED DFSP has reserved the transfer. -
-        COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP
-        has aborted the transfer due a rejection or failure to perform the
-        transfer.
+      description: |
+        Below are the allowed values for the enumeration - RECEIVED DFSP has received the transfer. - RESERVED DFSP has reserved the transfer. - COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP has aborted the transfer due a rejection or failure to perform the transfer.
       enum:
         - RECEIVED
         - RESERVED
@@ -1602,9 +1482,7 @@ components:
       properties:
         homeR2PTransactionId:
           type: string
-          description: >-
-            Transaction ID from the DFSP backend, used to reconcile transactions
-            between the Switch and DFSP backend systems.
+          description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
         transactionRequestState:
           $ref: '#/components/schemas/transactionRequestState'
       required:
@@ -1613,22 +1491,13 @@ components:
       title: TransactionSubScenario
       type: string
       pattern: ^[A-Z_]{1,32}$
-      description: >-
-        Possible sub-scenario, defined locally within the scheme (UndefinedEnum
-        Type).
+      description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
       example: LOCALLY_DEFINED_SUBSCENARIO
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
-      description: >-
-        Identifier that correlates all messages of the same sequence. The API
-        data type UUID (Universally Unique Identifier) is a JSON String in
-        canonical format, conforming to [RFC
-        4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
-        regular expression for interoperability reasons. A UUID is always 36
-        characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     bulkTransactionStatus:
       type: string
@@ -1649,11 +1518,7 @@ components:
             - true
     Currency:
       title: Currency
-      description: >-
-        The currency codes defined in [ISO
-        4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
-        alphabetic codes are used as the standard naming representation for
-        currencies.
+      description: The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies.
       type: string
       minLength: 3
       maxLength: 3
@@ -1826,13 +1691,7 @@ components:
       title: Amount
       type: string
       pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
-      description: >-
-        The API data type Amount is a JSON String in a canonical format that is
-        restricted by a regular expression for interoperability reasons. This
-        pattern does not allow any trailing zeroes at all, but allows an amount
-        without a minor currency unit. It also only allows four digits in the
-        minor currency unit; a negative value is not allowed. Using more than 18
-        digits in the major currency unit is not allowed.
+      description: The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed.
       example: '123.45'
     bulkPerTransferFeeLimit:
       type: object
@@ -1862,17 +1721,8 @@ components:
     DateTime:
       title: DateTime
       type: string
-      pattern: >-
-        ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
-      description: >-
-        The API data type DateTime is a JSON String in a lexical format that is
-        restricted by a regular expression for interoperability reasons. The
-        format is according to [ISO
-        8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed
-        in a combined date, time and time zone format. A more readable version
-        of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
-        "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
-        indicates Zulu time zone, same as UTC).
+      pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
+      description: The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC).
       example: '2016-05-24T08:38:08.699-04:00'
     bulkTransactionOptions:
       type: object
@@ -1882,33 +1732,20 @@ components:
         - bulkExpiration
       properties:
         onlyValidateParty:
-          description: >-
-            Set to true if only party validation is required.  This means the
-            quotes and transfers will not run. This is useful for only party
-            resolution.
+          description: Set to true if only party validation is required.  This means the quotes and transfers will not run. This is useful for only party resolution.
           type: boolean
         autoAcceptParty:
           $ref: '#/components/schemas/autoAcceptPartyOption'
         autoAcceptQuote:
-          description: >-
-            Set to true if the quote response is accepted without confirmation
-            from the payer. The fees applied by the payee will be acceptable to
-            the payer abiding by the limits set by optional
-            'perTransferFeeLimits' array.
+          description: Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array.
           type: object
           oneOf:
             - $ref: '#/components/schemas/autoAcceptQuote'
         skipPartyLookup:
-          description: >-
-            Set to true if supplying an FSPID for the payee party and no party
-            resolution is needed. This may be useful if a previous party
-            resolution has been performed.
+          description: Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed.
           type: boolean
         synchronous:
-          description: >-
-            Set to true if the bulkTransfer requests need be handled
-            synchronous. Otherwise the requests will be handled asynchronously,
-            meaning there will  be callbacks whenever the processing is done
+          description: Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will  be callbacks whenever the processing is done
           type: boolean
         bulkExpiration:
           $ref: '#/components/schemas/DateTime'
@@ -1924,52 +1761,16 @@ components:
         - ACCOUNT_ID
         - IBAN
         - ALIAS
-      description: >-
+      description: |-
         Below are the allowed values for the enumeration.
-
-        - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
-        Number, that is, the phone number) is used as reference to a
-        participant. The MSISDN identifier should be in international format
-        according to the [ITU-T E.164
-        standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the
-        MSISDN may be prefixed by a single plus sign, indicating the
-        international prefix.
-
-        - EMAIL - An email is used as reference to a participant. The format of
-        the email should be according to the informational [RFC
-        3696](https://tools.ietf.org/html/rfc3696).
-
-        - PERSONAL_ID - A personal identifier is used as reference to a
-        participant. Examples of personal identification are passport number,
-        birth certificate number, and national registration number. The
-        identifier number is added in the PartyIdentifier element. The personal
-        identifier type is added in the PartySubIdOrType element.
-
-        - BUSINESS - A specific Business (for example, an organization or a
-        company) is used as reference to a participant. The BUSINESS identifier
-        can be in any format. To make a transaction connected to a specific
-        username or bill number in a Business, the PartySubIdOrType element
-        should be used.
-
-        - DEVICE - A specific device (for example, a POS or ATM) ID connected to
-        a specific business or organization is used as reference to a Party. For
-        referencing a specific device under a specific business or organization,
-        use the PartySubIdOrType element.
-
-        - ACCOUNT_ID - A bank account number or FSP account ID should be used as
-        reference to a participant. The ACCOUNT_ID identifier can be in any
-        format, as formats can greatly differ depending on country and FSP.
-
-        - IBAN - A bank account number or FSP account ID is used as reference to
-        a participant. The IBAN identifier can consist of up to 34 alphanumeric
-        characters and should be entered without whitespace.
-
-        - ALIAS An alias is used as reference to a participant. The alias should
-        be created in the FSP as an alternative reference to an account owner.
-        Another example of an alias is a username in the FSP system. The ALIAS
-        identifier can be in any format. It is also possible to use the
-        PartySubIdOrType element for identifying an account under an Alias
-        defined by the PartyIdentifier.
+        - MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.
+        - EMAIL - An email is used as reference to a participant. The format of the email should be according to the informational [RFC 3696](https://tools.ietf.org/html/rfc3696).
+        - PERSONAL_ID - A personal identifier is used as reference to a participant. Examples of personal identification are passport number, birth certificate number, and national registration number. The identifier number is added in the PartyIdentifier element. The personal identifier type is added in the PartySubIdOrType element.
+        - BUSINESS - A specific Business (for example, an organization or a company) is used as reference to a participant. The BUSINESS identifier can be in any format. To make a transaction connected to a specific username or bill number in a Business, the PartySubIdOrType element should be used.
+        - DEVICE - A specific device (for example, a POS or ATM) ID connected to a specific business or organization is used as reference to a Party. For referencing a specific device under a specific business or organization, use the PartySubIdOrType element.
+        - ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.
+        - IBAN - A bank account number or FSP account ID is used as reference to a participant. The IBAN identifier can consist of up to 34 alphanumeric characters and should be entered without whitespace.
+        - ALIAS An alias is used as reference to a participant. The alias should be created in the FSP as an alternative reference to an account owner. Another example of an alias is a username in the FSP system. The ALIAS identifier can be in any format. It is also possible to use the PartySubIdOrType element for identifying an account under an Alias defined by the PartyIdentifier.
     PartyIdentifier:
       title: PartyIdentifier
       type: string
@@ -1982,9 +1783,7 @@ components:
       type: string
       minLength: 1
       maxLength: 128
-      description: >-
-        Either a sub-identifier of a PartyIdentifier, or a sub-type of the
-        PartyIdType, normally a PersonalIdentifierType.
+      description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
     ExtensionKey:
       title: ExtensionKey
       type: string
@@ -2012,9 +1811,7 @@ components:
     ExtensionList:
       title: ExtensionList
       type: object
-      description: >-
-        Data model for the complex type ExtensionList. An optional list of
-        extensions, specific to deployment.
+      description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
       properties:
         extension:
           type: array
@@ -2028,9 +1825,7 @@ components:
     PartyIdInfo:
       title: PartyIdInfo
       type: object
-      description: >-
-        Data model for the complex type PartyIdInfo. An ExtensionList element
-        has been added to this reqeust in version v1.1
+      description: Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
       properties:
         partyIdType:
           $ref: '#/components/schemas/PartyIdType'
@@ -2092,14 +1887,10 @@ components:
       enum:
         - SEND
         - RECEIVE
-      description: >-
+      description: |-
         Below are the allowed values for the enumeration AmountType.
-
-        - SEND - Amount the Payer would like to send, that is, the amount that
-        should be withdrawn from the Payer account including any fees.
-
-        - RECEIVE - Amount the Payer would like the Payee to receive, that is,
-        the amount that should be sent to the receiver exclusive of any fees.
+        - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
+        - RECEIVE - Amount the Payer would like the Payee to receive, that is, the amount that should be sent to the receiver exclusive of any fees.
       example: RECEIVE
     Note:
       title: Note
@@ -2123,27 +1914,19 @@ components:
     Latitude:
       title: Latitude
       type: string
-      pattern: >-
-        ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
-      description: >-
-        The API data type Latitude is a JSON String in a lexical format that is
-        restricted by a regular expression for interoperability reasons.
+      pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
+      description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
       example: '+45.4215'
     Longitude:
       title: Longitude
       type: string
-      pattern: >-
-        ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
-      description: >-
-        The API data type Longitude is a JSON String in a lexical format that is
-        restricted by a regular expression for interoperability reasons.
+      pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
+      description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
       example: '+75.6972'
     GeoCode:
       title: GeoCode
       type: object
-      description: >-
-        Data model for the complex type GeoCode. Indicates the geographic
-        location from where the transaction was initiated.
+      description: Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
       properties:
         latitude:
           $ref: '#/components/schemas/Latitude'
@@ -2159,8 +1942,7 @@ components:
       minLength: 1
       maxLength: 32768
       description: Information for recipient (transport layer information).
-      example: >-
-        AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
+      example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
     IlpCondition:
       title: IlpCondition
       type: string
@@ -2171,14 +1953,7 @@ components:
       title: ErrorCode
       type: string
       pattern: ^[1-9]\d{3}$
-      description: >-
-        The API data type ErrorCode is a JSON String of four characters,
-        consisting of digits only. Negative numbers are not allowed. A leading
-        zero is not allowed. Each error code in the API is a four-digit number,
-        for example, 1234, where the first number (1 in the example) represents
-        the high-level error category, the second number (2 in the example)
-        represents the low-level error category, and the last two numbers (34 in
-        the example) represent the specific error.
+      description: The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.
       example: '5100'
     ErrorDescription:
       title: ErrorDescription
@@ -2207,15 +1982,11 @@ components:
           $ref: '#/components/schemas/ErrorInformation'
     quoteError:
       type: object
-      description: >-
-        This object represents a Mojaloop API error received at any time during
-        the quote process
+      description: This object represents a Mojaloop API error received at any time during the quote process
       properties:
         httpStatusCode:
           type: integer
-          description: >-
-            The HTTP status code returned to the caller. This is the same as the
-            actual HTTP status code returned with the response.
+          description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
         mojaloopError:
           $ref: '#/components/schemas/mojaloopError'
     individualQuoteResult:
@@ -2258,30 +2029,20 @@ components:
         - RESERVED
         - COMMITTED
         - ABORTED
-      description: >-
+      description: |-
         Below are the allowed values for the enumeration.
-
         - RECEIVED - Next ledger has received the transfer.
-
         - RESERVED - Next ledger has reserved the transfer.
-
         - COMMITTED - Next ledger has successfully performed the transfer.
-
-        - ABORTED - Next ledger has aborted the transfer due to a rejection or
-        failure to perform the transfer.
+        - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
       example: RESERVED
     transferError:
       type: object
-      description: >-
-        This may be a Mojaloop API error returned from another entity in the
-        scheme or an object representing other types of error e.g. exceptions
-        that may occur inside the scheme adapter.
+      description: This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.
       properties:
         httpStatusCode:
           type: integer
-          description: >-
-            The HTTP status code returned to the caller. This is the same as the
-            actual HTTP status code returned with the response.
+          description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
         mojaloopError:
           $ref: '#/components/schemas/mojaloopError'
     individualTransferResult:
@@ -2308,9 +2069,7 @@ components:
           $ref: '#/components/schemas/CorrelationId'
         homeTransactionId:
           type: string
-          description: >-
-            Transaction ID from the DFSP backend, used to reconcile transactions
-            between the Switch and DFSP backend systems.
+          description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
         transactionId:
           $ref: '#/components/schemas/CorrelationId'
         to:
@@ -2349,9 +2108,7 @@ components:
       properties:
         bulkHomeTransactionID:
           type: string
-          description: >-
-            Transaction ID from the DFSP backend, used to reconcile transactions
-            between the Switch and DFSP backend systems.
+          description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
         bulkTransactionId:
           $ref: '#/components/schemas/CorrelationId'
         currentState: