@mojaloop/sdk-scheme-adapter 13.0.3 → 15.0.0

package/.circleci/config.yml

@@ -64,7 +64,7 @@ executors:
   default-docker:
     working_directory: /home/circleci/project
     docker:
-      - image: node:16-alpine
+      - image: node:16.15.0-alpine
 
   default-machine:
     machine:

package/.nvmrc

@@ -1 +1 @@
-v16.14
+v16.15.0

package/CHANGELOG.md

@@ -1,4 +1,33 @@
 # Changelog: [mojaloop/thirdparty-api-svc](https://github.com/mojaloop/thirdparty-api-svc)
+## [15.0.0](https://github.com/mojaloop/sdk-scheme-adapter/compare/v14.0.0...v15.0.0) (2022-06-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* added outbound bulk api (#320)
+
+### Features
+
+* added outbound bulk api ([#320](https://github.com/mojaloop/sdk-scheme-adapter/issues/320)) ([e2e83e9](https://github.com/mojaloop/sdk-scheme-adapter/commit/e2e83e99048a755b49123e91faa3acc03dded029))
+
+## [14.0.0](https://github.com/mojaloop/sdk-scheme-adapter/compare/v13.0.4...v14.0.0) (2022-05-19)
+
+
+### ⚠ BREAKING CHANGES
+
+* bump nodejs version and update central services (#319)
+
+### Features
+
+* bump nodejs version and update central services ([#319](https://github.com/mojaloop/sdk-scheme-adapter/issues/319)) ([ee5a6da](https://github.com/mojaloop/sdk-scheme-adapter/commit/ee5a6da0650aa186114755c88889c441da6dfe8a))
+
+### [13.0.4](https://github.com/mojaloop/sdk-scheme-adapter/compare/v13.0.3...v13.0.4) (2022-05-13)
+
+
+### Bug Fixes
+
+* reformat error information response ([#318](https://github.com/mojaloop/sdk-scheme-adapter/issues/318)) ([ed844b1](https://github.com/mojaloop/sdk-scheme-adapter/commit/ed844b1d2da6c58d3c61622c07c326bda3ca3b86))
+
 ### [13.0.3](https://github.com/mojaloop/sdk-scheme-adapter/compare/v13.0.2...v13.0.3) (2022-05-12)
 
 

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-alpine as builder
+FROM node:16.15.0-alpine as builder
 
 RUN apk add --no-cache git python3 build-base
 
@@ -12,7 +12,7 @@ WORKDIR /src
 COPY ./package.json .
 COPY ./package-lock.json .
 RUN npm ci --only=production
-FROM node:16-alpine
+FROM node:16.15.0-alpine
 
 ARG BUILD_DATE
 ARG VCS_URL

package/audit-resolve.json

@@ -407,8 +407,8 @@
     },
     "1068310|@mojaloop/central-services-shared>widdershins>yargs>yargs-parser": {
       "decision": "ignore",
-      "madeAt": 1649898256486,
-      "expiresAt": 1652490250295
+      "madeAt": 1654208208192,
+      "expiresAt": 1656800189114
     },
     "1067946|ajv": {
       "decision": "ignore",
@@ -417,13 +417,13 @@
     },
     "1070030|@mojaloop/central-services-shared>widdershins>markdown-it": {
       "decision": "ignore",
-      "madeAt": 1650460940438,
-      "expiresAt": 1653052932045
+      "madeAt": 1652982823332,
+      "expiresAt": 1655574816261
     },
     "1070030|@mojaloop/central-services-shared>shins>markdown-it": {
       "decision": "ignore",
-      "madeAt": 1650459472663,
-      "expiresAt": 1653051469252
+      "madeAt": 1654208210848,
+      "expiresAt": 1656800189114
     },
     "1068154|@mojaloop/central-services-shared>shins>sanitize-html": {
       "decision": "ignore",
@@ -432,8 +432,8 @@
     },
     "1068155|@mojaloop/central-services-shared>shins>sanitize-html": {
       "decision": "ignore",
-      "madeAt": 1650459475376,
-      "expiresAt": 1653051469252
+      "madeAt": 1654208203284,
+      "expiresAt": 1656800189114
     },
     "1070245|@mojaloop/central-services-shared>@mojaloop/event-sdk>moment": {
       "decision": "ignore",
@@ -452,8 +452,8 @@
     },
     "1070030|widdershins>markdown-it": {
       "decision": "ignore",
-      "madeAt": 1651072088351,
-      "expiresAt": 1653664079920
+      "madeAt": 1654209004788,
+      "expiresAt": 1656800991863
     },
     "1068154|@mojaloop/central-services-shared>@mojaloop/event-sdk>moment>shins>markdown-it>sanitize-html": {
       "decision": "ignore",
@@ -487,25 +487,115 @@
     },
     "1067553|swagger2openapi>better-ajv-errors>jsonpointer": {
       "decision": "ignore",
-      "madeAt": 1651072095680,
-      "expiresAt": 1653664079920
+      "madeAt": 1654209013381,
+      "expiresAt": 1656800991863
     },
     "1067946|swagger2openapi>better-ajv-errors>jsonpointer>oas-validator>ajv": {
       "decision": "ignore",
-      "madeAt": 1651072096735,
-      "expiresAt": 1653664079920
+      "madeAt": 1654209015474,
+      "expiresAt": 1656800991863
     },
     "1068310|widdershins>markdown-it>yargs>yargs-parser": {
       "decision": "ignore",
-      "madeAt": 1651072098082,
-      "expiresAt": 1653664079920
+      "madeAt": 1654209017825,
+      "expiresAt": 1656800991863
     },
     "1070260|@mojaloop/central-services-shared>shins>sanitize-html": {
       "decision": "ignore",
-      "madeAt": 1651249549067,
-      "expiresAt": 1653841542147
+      "madeAt": 1654208205836,
+      "expiresAt": 1656800189114
+    },
+    "1068155|@mojaloop/central-services-shared>shins>markdown-it>sanitize-html": {
+      "decision": "ignore",
+      "madeAt": 1652981366297,
+      "expiresAt": 1655573359219
+    },
+    "1070260|@mojaloop/central-services-shared>shins>markdown-it>sanitize-html": {
+      "decision": "ignore",
+      "madeAt": 1652981367363,
+      "expiresAt": 1655573359219
+    },
+    "1070030|shins>markdown-it": {
+      "decision": "ignore",
+      "madeAt": 1654872421648,
+      "expiresAt": 1657464405390
+    },
+    "1068310|@mojaloop/central-services-shared>widdershins>markdown-it>yargs>yargs-parser": {
+      "decision": "ignore",
+      "madeAt": 1652982824567,
+      "expiresAt": 1655574816261
+    },
+    "1068155|shins>markdown-it>sanitize-html": {
+      "decision": "ignore",
+      "madeAt": 1652982826025,
+      "expiresAt": 1655574816261
+    },
+    "1070260|shins>markdown-it>sanitize-html": {
+      "decision": "ignore",
+      "madeAt": 1652982827137,
+      "expiresAt": 1655574816261
+    },
+    "1067553|@mojaloop/central-services-shared>widdershins>swagger2openapi>better-ajv-errors>jsonpointer": {
+      "decision": "ignore",
+      "madeAt": 1654208197641,
+      "expiresAt": 1656800189114
+    },
+    "1067553|@mojaloop/central-services-shared>widdershins>swagger2openapi>oas-validator>better-ajv-errors>jsonpointer": {
+      "decision": "ignore",
+      "madeAt": 1654208197642,
+      "expiresAt": 1656800189114
+    },
+    "1067946|@mojaloop/central-services-shared>widdershins>swagger2openapi>oas-validator>ajv": {
+      "decision": "ignore",
+      "madeAt": 1654208200360,
+      "expiresAt": 1656800189114
+    },
+    "1070412|@mojaloop/central-services-shared>shins>ejs": {
+      "decision": "ignore",
+      "madeAt": 1654208217831,
+      "expiresAt": 1656800189114
+    },
+    "1070449|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs": {
+      "decision": "ignore",
+      "madeAt": 1654209002758,
+      "expiresAt": 1656800991863
+    },
+    "1070030|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>shins>markdown-it": {
+      "decision": "ignore",
+      "madeAt": 1654209004788,
+      "expiresAt": 1656800991863
+    },
+    "1068155|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>shins>markdown-it>sanitize-html": {
+      "decision": "ignore",
+      "madeAt": 1654209006663,
+      "expiresAt": 1656800991863
+    },
+    "1070260|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>shins>markdown-it>sanitize-html": {
+      "decision": "ignore",
+      "madeAt": 1654209008676,
+      "expiresAt": 1656800991863
+    },
+    "1070412|ejs": {
+      "decision": "ignore",
+      "madeAt": 1654209011201,
+      "expiresAt": 1656800991863
+    },
+    "1070483|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs": {
+      "decision": "ignore",
+      "madeAt": 1654872419659,
+      "expiresAt": 1657464405390
+    },
+    "1070030|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>widdershins>markdown-it": {
+      "decision": "ignore",
+      "madeAt": 1654872421648,
+      "expiresAt": 1657464405390
+    },
+    "1068310|@mojaloop/central-services-shared>@mojaloop/event-sdk>grpc>protobufjs>widdershins>markdown-it>yargs>yargs-parser": {
+      "decision": "ignore",
+      "madeAt": 1654872423852,
+      "expiresAt": 1657464405390
     }
   },
   "rules": {},
   "version": 1
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-scheme-adapter",
-  "version": "13.0.3",
+  "version": "15.0.0",
   "description": "An adapter for connecting to Mojaloop API enabled switches.",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -54,15 +54,9 @@
   },
   "dependencies": {
     "@koa/cors": "^3.1.0",
-    "@mojaloop/central-services-error-handling": "11.3.0",
-    "@mojaloop/central-services-health": "13.0.0",
-    "@mojaloop/central-services-logger": "10.6.1",
-    "@mojaloop/central-services-metrics": "11.0.0",
-    "@mojaloop/central-services-shared": "14.0.0",
-    "@mojaloop/event-sdk": "10.7.1",
-    "@mojaloop/sdk-standard-components": "^16.0.0",
-    "ajv": "8.6.3",
-    "ajv-keywords": "5.0.0",
+    "@mojaloop/central-services-shared": "17.0.2",
+    "@mojaloop/sdk-standard-components": "^17.0.1",
+    "ajv": "8.11.0",
     "axios": "^0.21.4",
     "co-body": "^6.1.0",
     "dotenv": "^10.0.0",

package/src/OutboundServer/api.yaml

@@ -17,8 +17,8 @@ info:
     the term "FSP" is equal to the term "DFSP".
   license:
     name: 'Apache License Version 2.0, January 2004'
-    url: 'http://www.apache.org/licenses/'
-  version: 1.0.0
+    url: 'https://github.com/mojaloop/documentation/blob/master/LICENSE.md'
+  version: 2.0.0
 paths:
   /:
     get:
@@ -165,33 +165,37 @@ paths:
               $ref: '#/components/schemas/bulkTransferRequest'
         required: true
       responses:
-        '200':
-          $ref: '#/components/responses/bulkTransferSuccess'
+        '202':
+          $ref: '#/components/responses/bulkTransferAccepted'
         '400':
           $ref: '#/components/responses/bulkTransferBadRequest'
         '500':
-          $ref: '#/components/responses/bulkTransferServerError'
-        '504':
-          $ref: '#/components/responses/bulkTransferTimeout'
+          $ref: '#/components/schemas/errorResponse'
   '/bulkTransfers/{bulkTransferId}':
-    get:
-      summary: Retrieves information for a specific bulk transfer
+    put:
+      summary: Amends the bulk transfer request
       description: >-
-        The HTTP request `GET /bulkTransfers/{bulktTransferId}` is used to get
-        information regarding a bulk transfer created or requested earlier. The
-        `{bulkTransferId}` in the URI should contain the `bulkTransferId` that
+        The HTTP request `PUT /bulkTransfers/{bulkTransferId}` is used to amend
+        information regarding a bulk transfer, i.e. when autoAcceptParty or autoAcceptQuote 
+        is false then the payer need to provide confirmation to proceed with further processing
+        of the request. The `{bulkTransferId}` in the URI should contain the `bulkTransferId` that
         was used for the creation of the bulk transfer.
       tags:
         - BulkTransfers
       parameters:
         - $ref: '#/components/parameters/bulkTransferId'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              oneOf:
+                - $ref: '#/components/schemas/bulkTransferContinuationAcceptParty'
+                - $ref: '#/components/schemas/bulkTransferContinuationAcceptQuote'      
       responses:
-        '200':
-          description: Bulk transfer information successfully retrieved
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/bulkTransferStatusResponse'
+        '202':
+          description: Bulk transfer information successfully amended
+        '400':
+           $ref: '#/components/responses/bulkTransferPutBadRequest'
         '500':
           description: An error occurred processing the bulk transfer
           content:
@@ -470,6 +474,31 @@ paths:
           $ref: '#/components/responses/simpleTransfersServerError'
 components:
   schemas:
+    autoAcceptPartyOption:
+      type: object
+      required:
+        - enabled
+      properties:
+        enabled:
+          type: boolean
+          enum:
+            - false
+            - true
+    autoAcceptQuote:
+      type: object
+      required:
+        - enabled
+      properties:
+        enabled:
+          type: boolean
+          enum:
+            - true
+            - false
+        perTransferFeeLimits:
+          type: array
+          minItems: 0
+          items: 
+            $ref: '#/components/schemas/bulkPerTransferFeeLimit'
     TransactionInitiatorType:
       title: TransactionInitiatorType
       type: string
@@ -724,6 +753,191 @@ components:
         $ref: '#/components/schemas/Extension'
       minItems: 0
       maxItems: 16
+    bulkPartyLookupResponse:
+      description: >-
+        The object sent back to the payer for confirmation of payee parties.
+        It's basically the same object as the original bulk transfer request 
+        with party information is added for all the payees
+      type: object
+      required:
+        - bulkHomeTransactionID
+        - from
+        - individualTransfers
+      properties:
+        bulkHomeTransactionID:
+          type: string
+          description: >-
+            Transaction ID from the DFSP backend, used to reconcile transactions
+            between the Switch and DFSP backend systems.
+        options:
+          $ref: '#/components/schemas/bulkTransferOptions'
+        from:
+          $ref: '#/components/schemas/Party'
+        individualTransfers:
+          description: List of individual transfers in a bulk transfer.
+          type: array
+          minItems: 1
+          maxItems: 1000
+          items:
+            allOf:
+              - $ref: '#/components/schemas/individualTransfer'
+              - type: object
+                required:
+                  - transactionId
+                properties:
+                  transactionId:
+                    $ref: '#/components/schemas/CorrelationId'
+
+        extensions:
+          $ref: '#/components/schemas/ExtensionList'
+        lastError:
+          description: >
+            Object representing the last error to occur during a party discovery process.
+            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.
+          $ref: '#/components/schemas/partyError'
+    bulkQuoteRequestResponse:
+      description: >-
+        The object sent back to the payer for confirmation of quotes.
+        It's basically the same object as the original bulk transfer request 
+        with quote information added for all the transfers
+      type: object
+      required:
+        - bulkHomeTransactionID
+        - from
+        - individualTransfers
+      properties:
+        bulkHomeTransactionID:
+          type: string
+          description: >-
+            Transaction ID from the DFSP backend, used to reconcile transactions
+            between the Switch and DFSP backend systems.
+        options:
+          $ref: '#/components/schemas/bulkTransferOptions'
+        from:
+          $ref: '#/components/schemas/Party'
+        individualTransfers:
+          description: List of individual transfers in a bulk transfer.
+          type: array
+          minItems: 1
+          maxItems: 1000
+          items:
+            allOf:
+              - $ref: '#/components/schemas/individualTransfer'
+              - type: object
+                required:
+                 - transactionId
+                properties:
+                  transactionId:
+                    $ref: '#/components/schemas/CorrelationId'
+              - type: object
+                required:
+                 - quoteResponse
+                properties:
+                  quoteResponse:
+                    $ref: '#/components/schemas/QuotesIDPutResponse'
+        extensions:
+          $ref: '#/components/schemas/ExtensionList'
+        lastError:
+          description: >
+            Object representing the last error to occur during a party discovery process.
+            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.
+          $ref: '#/components/schemas/partyError'
+
+    bulkTransferContinuationAcceptParty:
+      description: >-
+        The object sent back as confirmation of payee parties when autoAcceptParty is false.
+      type: object
+      required:
+        - bulkHomeTransactionID
+        - individualTransfers
+      properties:
+        bulkHomeTransactionID:
+          type: string
+          description: >-
+            Transaction ID from the DFSP backend, used to reconcile transactions
+            between the Switch and DFSP backend systems.
+        individualTransfers:
+          description: List of individual transfers in a bulk transfer with accept party information.
+          type: array
+          minItems: 1
+          maxItems: 1000
+          items:
+            allOf:
+              - $ref: '#/components/schemas/individualTransferAccept'
+              - $ref: '#/components/schemas/transferContinuationAcceptParty'
+    bulkTransferContinuationAcceptQuote:
+      description: >-
+        The object sent back as confirmation of quotes when autoAcceptQuotes is false.
+      type: object
+      required:
+        - bulkHomeTransactionID
+        - individualTransfers
+      properties:
+        bulkHomeTransactionID:
+          type: string
+          description: >-
+            Transaction ID from the DFSP backend, used to reconcile transactions
+            between the Switch and DFSP backend systems.
+        individualTransfers:
+          description: List of individual transfers in a bulk transfer.
+          type: array
+          minItems: 1
+          maxItems: 1000
+          items:
+            allOf:
+              - $ref: '#/components/schemas/individualTransferAccept'
+              - $ref: '#/components/schemas/transferContinuationAcceptQuote'
+    bulkTransferOptions:
+      type: object
+      required:
+        - autoAcceptParty
+        - autoAcceptQuote
+        - 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.
+          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.
+          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.
+          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
+          type: boolean
+        bulkExpiration:
+          $ref: '#/components/schemas/DateTime'
+    bulkPerTransferFeeLimit:
+      type: object
+      required:
+        - currency
+        - amount
+      properties:
+        currency:
+          $ref: '#/components/schemas/Currency'
+        amount:
+          $ref: '#/components/schemas/Amount'
     transferParty:
       type: object
       required:
@@ -1005,7 +1219,7 @@ components:
         skipPartyLookup:
           description: >-
             Set to true if supplying an FSPID for the payee party and no party
-            resolution is needed. This may be useful is a previous party
+            resolution is needed. This may be useful if a previous party
             resolution has been performed.
           type: boolean
     CorrelationId:
@@ -1243,6 +1457,39 @@ components:
             asynchronous Mojaloop API exchange, this property will contain the
             underlying Mojaloop API error object.
           $ref: '#/components/schemas/mojaloopError'
+    validationError:
+      type: object
+      description: >-
+        This object represents an error occurred during the initial validation of individual transfers in bulk
+      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.
+        mojaloopError:
+          description: >-
+            If a transfer process results in an error callback during the
+            asynchronous Mojaloop API exchange, this property will contain the
+            underlying Mojaloop API error object.
+          $ref: '#/components/schemas/mojaloopError'
+    partyError:
+      type: object
+      description: >-
+        This object represents a Mojaloop API error received at any time during
+        the party discovery 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.
+        mojaloopError:
+          description: >-
+            If a transfer process results in an error callback during the
+            asynchronous Mojaloop API exchange, this property will contain the
+            underlying Mojaloop API error object.
+          $ref: '#/components/schemas/mojaloopError'
     transferResponse:
       type: object
       required:
@@ -1323,7 +1570,7 @@ components:
         skipPartyLookup:
           description: >-
             Set to true if supplying an FSPID for the payee party and no party
-            resolution is needed. This may be useful is a previous party
+            resolution is needed. This may be useful if a previous party
             resolution has been performed.
           type: boolean
     errorResponse:
@@ -1388,44 +1635,73 @@ components:
       type: object
       description: Data model for the complex type 'individualTransfer'.
       properties:
-        transferId:
+        homeTransactionId:
           $ref: '#/components/schemas/CorrelationId'
         to:
-          $ref: '#/components/schemas/transferParty'
+          $ref: '#/components/schemas/Party'
+        reference:
+          description: Payer Loan reference
+          type: string
         amountType:
           $ref: '#/components/schemas/AmountType'
         currency:
           $ref: '#/components/schemas/Currency'
         amount:
           $ref: '#/components/schemas/Amount'
-        transactionType:
-          $ref: '#/components/schemas/transactionType'
+        # transactionType:
+        #   $ref: '#/components/schemas/transactionType'
+        # transferValidStatus:
+        #   description: >-
+        #     Set to true when the transfer request is valid
+        #   type: boolean
         note:
           $ref: '#/components/schemas/Note'
-        extensions:
+        quoteRequestExtensions:
           $ref: '#/components/schemas/ExtensionList'
+        transferRequestExtensions:
+          $ref: '#/components/schemas/ExtensionList'
+        lastError:
+          description: >
+            Object representing the error occured during initial validation.
+          $ref: '#/components/schemas/validationError'
       required:
-        - transferId
+        - homeTransactionId
         - to
         - amountType
         - currency
-        - transactionType
-    bulkTransferRequest:
+        - amount
+        # - transactionType
+        # - transferValidStatus
+    individualTransferAccept:
+      title: IndividualTransfer
       type: object
+      description: Data model for the 'individualTransfer' while accepting party or quote.
+      properties:
+        homeTransactionId:
+          $ref: '#/components/schemas/CorrelationId'
+        transactionId:
+          $ref: '#/components/schemas/CorrelationId'          
       required:
         - homeTransactionId
+        - transactionId
+
+    bulkTransferRequest:
+      type: object
+      required:
+        - bulkHomeTransactionID
+        - options
         - from
         - individualTransfers
       properties:
-        homeTransactionId:
+        bulkHomeTransactionID:
           type: string
           description: >-
             Transaction ID from the DFSP backend, used to reconcile transactions
             between the Switch and DFSP backend systems.
-        bulkTransferId:
-          $ref: '#/components/schemas/CorrelationId'
+        options:
+          $ref: '#/components/schemas/bulkTransferOptions'
         from:
-          $ref: '#/components/schemas/transferParty'
+          $ref: '#/components/schemas/Party'
         individualTransfers:
           description: List of individual transfers in a bulk transfer.
           type: array
@@ -1440,8 +1716,12 @@ components:
       properties:
         transferId:
           $ref: '#/components/schemas/CorrelationId'
+        homeTransactionId:
+          $ref: '#/components/schemas/CorrelationId'
+        transactionId:
+          $ref: '#/components/schemas/CorrelationId'
         to:
-          $ref: '#/components/schemas/transferParty'
+          $ref: '#/components/schemas/Party'
         amountType:
           $ref: '#/components/schemas/AmountType'
         currency:
@@ -1456,15 +1736,12 @@ components:
           $ref: '#/components/schemas/CorrelationId'
         quoteResponse:
           $ref: '#/components/schemas/QuotesIDPutResponse'
-        quoteResponseSource:
-          type: string
-          description: >
-            FSPID of the entity that supplied the quote response. This may not
-            be the same as the FSPID of the entity which owns the end user
-            account in the case of a FOREX transfer. i.e. it may be a FOREX
-            gateway.
         fulfil:
           $ref: '#/components/schemas/TransfersIDPutResponse'
+        quoteRequestExtensions:
+          $ref: '#/components/schemas/ExtensionList'
+        transferRequestExtensions:
+          $ref: '#/components/schemas/ExtensionList'
         lastError:
           description: >
             Object representing the last error to occur during a transfer
@@ -1475,19 +1752,50 @@ components:
     bulkTransferResponse:
       type: object
       required:
+        - bulkHomeTransactionID
         - from
+        - bulkExpiration
         - individualTransferResults
       properties:
-        transferId:
-          $ref: '#/components/schemas/CorrelationId'
-        from:
-          $ref: '#/components/schemas/transferParty'
+        bulkHomeTransactionID:
+          type: string
+          description: >-
+            Transaction ID from the DFSP backend, used to reconcile transactions
+            between the Switch and DFSP backend systems.
+        bulkExpiration:
+          $ref: '#/components/schemas/DateTime'
+        currentState:
+          $ref: '#/components/schemas/bulkTransferStatus'
         individualTransferResults:
           type: array
           maxItems: 1000
           items:
             $ref: '#/components/schemas/individualTransferResult'
           description: List of individual transfer result in a bulk transfer response.
+        extensions:
+          $ref: '#/components/schemas/ExtensionList'
+    bulkAcceptPartyErrorResponse:
+      allOf:
+        - $ref: '#/components/schemas/errorResponse'
+        - type: object
+          required:
+            - bulkTansferState
+          properties:
+            bulkTransferState:
+              allOf:
+                - $ref: '#/components/schemas/bulkTransferContinuationAcceptParty'
+                - $ref: '#/components/schemas/partyError'
+    bulkAcceptQuoteErrorResponse:
+      allOf:
+        - $ref: '#/components/schemas/errorResponse'
+        - type: object
+          required:
+            - bulkTansferState
+          properties:
+            bulkTransferState:
+              allOf:
+                - $ref: '#/components/schemas/bulkTransferContinuationAcceptQuote'
+                - $ref: '#/components/schemas/quoteError'
     bulkTransferErrorResponse:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
@@ -1501,6 +1809,8 @@ components:
       type: string
       enum:
         - ERROR_OCCURRED
+        - WAITING_FOR_PARTY_ACCEPTANCE
+        - WAITING_FOR_QUOTE_ACCEPTANCE
         - COMPLETED
     individualTransferFulfilment:
       type: object
@@ -2379,6 +2689,22 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/bulkTransferResponse'
+    bulkTransferAccepted:
+      description: Bulk transfer accepted successfully
+    bulkPartyLookupResponse:
+      description: Bulk party lookup completed successfully
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/bulkPartyLookupResponse'
+    bulkTransferPutBadRequest:
+      description: 'Malformed or missing required body, headers or parameters'
+      content:
+        application/json:
+          schema:
+            oneOf:
+              - $ref: '#/components/schemas/bulkAcceptPartyErrorResponse'
+              - $ref: '#/components/schemas/bulkAcceptQuoteErrorResponse'
     bulkTransferBadRequest:
       description: 'Malformed or missing required body, headers or parameters'
       content:

package/src/lib/model/OutboundBulkQuotesModel.js

@@ -162,8 +162,8 @@ class OutboundBulkQuotesModel {
                             }
                         }
                     } else if (message.type === 'bulkQuoteResponseError') {
-                        error = new BackendError(`Got an error response requesting bulk quote: ${util.inspect(message.data, { depth: Infinity })}`, 500);
-                        error.mojaloopError = message.data;
+                        error = new BackendError(`Got an error response requesting bulk quote: ${util.inspect(message.data.body, { depth: Infinity })}`, 500);
+                        error.mojaloopError = message.data.body;
                     }
                     else {
                         this._logger.push({ message }).log(`Ignoring cache notification for bulk quote ${bulkQuoteKey}. Unknown message type ${message.type}.`);
@@ -297,8 +297,8 @@ class OutboundBulkQuotesModel {
                     let message = JSON.parse(msg);
 
                     if (message.type === 'bulkQuoteError') {
-                        error = new BackendError(`Got an error response retrieving bulk quote: ${util.inspect(message.data, { depth: Infinity })}`, 500);
-                        error.mojaloopError = message.data;
+                        error = new BackendError(`Got an error response retrieving bulk quote: ${util.inspect(message.data.body, { depth: Infinity })}`, 500);
+                        error.mojaloopError = message.data.body;
                     } else if (message.type !== 'bulkQuoteResponse') {
                         this._logger.push({ message }).log(`Ignoring cache notification for bulk quote ${bulkQuoteKey}. Uknokwn message type ${message.type}.`);
                         return;

package/src/lib/model/OutboundBulkTransfersModel.js

@@ -161,8 +161,8 @@ class OutboundBulkTransfersModel {
                             }
                         }
                     } else if (message.type === 'bulkTransferError') {
-                        error = new BackendError(`Got an error response preparing bulk transfer: ${util.inspect(message.data, { depth: Infinity })}`, 500);
-                        error.mojaloopError = message.data;
+                        error = new BackendError(`Got an error response preparing bulk transfer: ${util.inspect(message.data.body, { depth: Infinity })}`, 500);
+                        error.mojaloopError = message.data.body;
                     }
                     else {
                         this._logger.push({ message }).log(`Ignoring cache notification for bulk transfer ${bulkTransferKey}. Unknown message type ${message.type}.`);
@@ -289,8 +289,8 @@ class OutboundBulkTransfersModel {
                     let message = JSON.parse(msg);
 
                     if (message.type === 'bulkTransferError') {
-                        error = new BackendError(`Got an error response retrieving bulk transfer: ${util.inspect(message.data, { depth: Infinity })}`, 500);
-                        error.mojaloopError = message.data;
+                        error = new BackendError(`Got an error response retrieving bulk transfer: ${util.inspect(message.data.body, { depth: Infinity })}`, 500);
+                        error.mojaloopError = message.data.body;
                     } else if (message.type !== 'bulkTransferFulfil') {
                         this._logger.push({ message }).log(`Ignoring cache notification for bulk transfer ${bulkTransferKey}. Uknokwn message type ${message.type}.`);
                         return;

package/src/lib/model/OutboundRequestToPayTransferModel.js

@@ -267,11 +267,10 @@ class OutboundRequestToPayTransferModel {
             const subId = await this._cache.subscribe(payeeKey, (cn, msg, subId) => {
                 try {
                     let payee = JSON.parse(msg);
-
-                    if(payee.errorInformation) {
+                    if(payee.body && payee.body.errorInformation) {
                         // this is an error response to our GET /parties request
-                        const err = new BackendError(`Got an error response resolving party: ${util.inspect(payee)}`, 500);
-                        err.mojaloopError = payee;
+                        const err = new BackendError(`Got an error response resolving party: ${util.inspect(payee.body)}`, 500);
+                        err.mojaloopError = payee.body;
 
                         // cancel the timeout handler
                         clearTimeout(timeout);
@@ -405,8 +404,8 @@ class OutboundRequestToPayTransferModel {
                             }
                         }
                     } else if (message.type === 'quoteResponseError') {
-                        error = new BackendError(`Got an error response requesting quote: ${util.inspect(message.data)}`, 500);
-                        error.mojaloopError = message.data;
+                        error = new BackendError(`Got an error response requesting quote: ${util.inspect(message.data.body)}`, 500);
+                        error.mojaloopError = message.data.body;
                     }
                     else {
                         this._logger.push({ message }).log(`Ignoring cache notification for quote ${quoteKey}. Unknown message type ${message.type}.`);
@@ -620,8 +619,8 @@ class OutboundRequestToPayTransferModel {
                             }
                         }
                     } else if (message.type === 'transferError') {
-                        error = new BackendError(`Got an error response preparing transfer: ${util.inspect(message.data)}`, 500);
-                        error.mojaloopError = message.data;
+                        error = new BackendError(`Got an error response preparing transfer: ${util.inspect(message.data.body)}`, 500);
+                        error.mojaloopError = message.data.body;
                     } else {
                         this._logger.push({ message }).log(`Ignoring cache notification for transfer ${transferKey}. Uknokwn message type ${message.type}.`);
                         return;
@@ -701,8 +700,8 @@ class OutboundRequestToPayTransferModel {
                     let message = JSON.parse(msg);
 
                     if (message.type === 'transferError') {
-                        error = new BackendError(`Got an error response retrieving transfer: ${util.inspect(message.data)}`, 500);
-                        error.mojaloopError = message.data;
+                        error = new BackendError(`Got an error response retrieving transfer: ${util.inspect(message.data.body)}`, 500);
+                        error.mojaloopError = message.data.body;
                     } else if (message.type !== 'transferFulfil') {
                         this._logger.push({ message }).log(`Ignoring cache notification for transfer ${transferKey}. Uknokwn message type ${message.type}.`);
                         return;

package/src/lib/model/OutboundTransfersModel.js

@@ -497,8 +497,8 @@ class OutboundTransfersModel {
                             }
                         }
                     } else if (message.type === 'quoteResponseError') {
-                        error = new BackendError(`Got an error response requesting quote: ${util.inspect(message.data, { depth: Infinity })}`, 500);
-                        error.mojaloopError = message.data;
+                        error = new BackendError(`Got an error response requesting quote: ${util.inspect(message.data.body, { depth: Infinity })}`, 500);
+                        error.mojaloopError = message.data.body;
                     }
                     else {
                         this._logger.push({ message }).log(`Ignoring cache notification for quote ${quoteKey}. Unknown message type ${message.type}.`);

package/test/unit/lib/model/OutboundBulkQuotesModel.test.js

@@ -207,10 +207,13 @@ describe('OutboundBulkQuotesModel', () => {
         const expectError = {
             type: 'bulkQuoteResponseError',
             data: {
-                errorInformation: {
-                    errorCode: '3205',
-                    errorDescription: 'Bulk quote ID not found'
-                }
+                body: {
+                    errorInformation: {
+                        errorCode: '3205',
+                        errorDescription: 'Bulk quote ID not found'
+                    }
+                },
+                headers: {}
             }
         };
 
@@ -239,7 +242,7 @@ describe('OutboundBulkQuotesModel', () => {
             expect(err.message.replace(/[ \n]/g,'')).toEqual(errMsg.replace(/[ \n]/g,''));
             expect(err.bulkQuoteState).toBeTruthy();
             expect(err.bulkQuoteState.lastError).toBeTruthy();
-            expect(err.bulkQuoteState.lastError.mojaloopError).toEqual(expectError.data);
+            expect(err.bulkQuoteState.lastError.mojaloopError).toEqual(expectError.data.body);
             expect(err.bulkQuoteState.lastError.bulkQuoteState).toBe(undefined);
             return;
         }

package/test/unit/lib/model/OutboundBulkTransfersModel.test.js

@@ -202,10 +202,13 @@ describe('outboundBulkTransferModel', () => {
         const expectError = {
             type: 'bulkTransferError',
             data: {
-                errorInformation: {
-                    errorCode: '4001',
-                    errorDescription: 'Payer FSP insufficient liquidity'
-                }
+                body: {
+                    errorInformation: {
+                        errorCode: '4001',
+                        errorDescription: 'Payer FSP insufficient liquidity'
+                    }
+                },
+                headers: {}
             }
         };
 
@@ -234,7 +237,7 @@ describe('outboundBulkTransferModel', () => {
             expect(err.message.replace(/[ \n]/g,'')).toEqual(errMsg.replace(/[ \n]/g,''));
             expect(err.bulkTransferState).toBeTruthy();
             expect(err.bulkTransferState.lastError).toBeTruthy();
-            expect(err.bulkTransferState.lastError.mojaloopError).toEqual(expectError.data);
+            expect(err.bulkTransferState.lastError.mojaloopError).toEqual(expectError.data.body);
             expect(err.bulkTransferState.lastError.bulkTransferState).toBe(undefined);
             return;
         }

package/test/unit/lib/model/OutboundTransfersModel.test.js

@@ -1390,10 +1390,13 @@ describe('outboundModel', () => {
         const expectError = {
             type: 'quoteResponseError',
             data: {
-                errorInformation: {
-                    errorCode: '3205',
-                    errorDescription: 'Quote ID not found'
-                }
+                body: {
+                    errorInformation: {
+                        errorCode: '3205',
+                        errorDescription: 'Quote ID not found'
+                    }
+                },
+                headers: {}
             }
         };
 
@@ -1430,7 +1433,7 @@ describe('outboundModel', () => {
             expect(err.message.replace(/[ \n]/g,'')).toEqual(errMsg.replace(/[ \n]/g,''));
             expect(err.transferState).toBeTruthy();
             expect(err.transferState.lastError).toBeTruthy();
-            expect(err.transferState.lastError.mojaloopError).toEqual(expectError.data);
+            expect(err.transferState.lastError.mojaloopError).toEqual(expectError.data.body);
             expect(err.transferState.lastError.transferState).toBe(undefined);
             return;
         }