@mojaloop/sdk-scheme-adapter 12.3.0 → 13.0.2

package/src/OutboundServer/api.yaml

@@ -1002,6 +1002,12 @@ components:
           $ref: '#/components/schemas/extensionListEmptiable'
         transferRequestExtensions:
           $ref: '#/components/schemas/extensionListEmptiable'
+        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 has been performed.
+          type: boolean
     CorrelationId:
       title: CorrelationId
       type: string
@@ -1273,8 +1279,24 @@ components:
           $ref: '#/components/schemas/transferStatus'
         quoteId:
           $ref: '#/components/schemas/CorrelationId'
+        getPartiesResponse:
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              type: object
+            headers:
+              type: object
         quoteResponse:
-          $ref: '#/components/schemas/QuotesIDPutResponse'
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              $ref: '#/components/schemas/QuotesIDPutResponse'
+            headers:
+              type: object
         quoteResponseSource:
           type: string
           description: >
@@ -1283,7 +1305,14 @@ components:
             account in the case of a FOREX transfer. i.e. it may be a FOREX
             gateway.
         fulfil:
-          $ref: '#/components/schemas/TransfersIDPutResponse'
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              $ref: '#/components/schemas/TransfersIDPutResponse'
+            headers:
+              type: object
         lastError:
           description: >
             Object representing the last error to occur during a transfer
@@ -1291,6 +1320,12 @@ components:
             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/transferError'
+        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 has been performed.
+          type: boolean
     errorResponse:
       type: object
       properties:
@@ -1321,7 +1356,14 @@ components:
         currentState:
           $ref: '#/components/schemas/transferStatus'
         fulfil:
-          $ref: '#/components/schemas/TransfersIDPutResponse'
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              $ref: '#/components/schemas/TransfersIDPutResponse'
+            headers:
+              type: object
     transferContinuationAcceptParty:
       type: object
       required:
@@ -1993,6 +2035,15 @@ components:
           $ref: '#/components/schemas/accountsCreationState'
         lastError:
           $ref: '#/components/schemas/transferError'
+        postAccountsResponse:
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              type: object
+            headers:
+              type: object
     errorAccountsResponse:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
@@ -2073,8 +2124,15 @@ components:
       description: 'GET /parties/{Type}/{ID} response object'
       properties:
         party:
-          $ref: '#/components/schemas/Party'
-          description: Information regarding the requested Party.
+          properties:
+            body:
+              $ref: '#/components/schemas/Party'
+              description: Information regarding the requested Party.
+            headers:
+              type: object
+          required:
+            - body
+            - headers
         currentState:
           $ref: '#/components/schemas/async2SyncCurrentState'
       required:
@@ -2184,33 +2242,41 @@ components:
           type: object
           description: 'The object sent in the PUT /quotes/{ID} callback.'
           properties:
-            transferAmount:
-              $ref: '#/components/schemas/Money'
-            payeeReceiveAmount:
-              $ref: '#/components/schemas/Money'
-            payeeFspFee:
-              $ref: '#/components/schemas/Money'
-            payeeFspCommission:
-              $ref: '#/components/schemas/Money'
-            expiration:
-              type: string
-              description: >-
-                Date and time until when the quotation is valid and can be
-                honored when used in the subsequent transaction.
-              example: '2016-05-24T08:38:08.699-04:00'
-            geoCode:
-              $ref: '#/components/schemas/GeoCode'
-            ilpPacket:
-              $ref: '#/components/schemas/IlpPacket'
-            condition:
-              $ref: '#/components/schemas/IlpCondition'
-            extensionList:
-              $ref: '#/components/schemas/ExtensionList'
+            body:
+              type: object
+              properties:
+                transferAmount:
+                  $ref: '#/components/schemas/Money'
+                payeeReceiveAmount:
+                  $ref: '#/components/schemas/Money'
+                payeeFspFee:
+                  $ref: '#/components/schemas/Money'
+                payeeFspCommission:
+                  $ref: '#/components/schemas/Money'
+                expiration:
+                  type: string
+                  description: >-
+                    Date and time until when the quotation is valid and can be
+                    honored when used in the subsequent transaction.
+                  example: '2016-05-24T08:38:08.699-04:00'
+                geoCode:
+                  $ref: '#/components/schemas/GeoCode'
+                ilpPacket:
+                  $ref: '#/components/schemas/IlpPacket'
+                condition:
+                  $ref: '#/components/schemas/IlpCondition'
+                extensionList:
+                  $ref: '#/components/schemas/ExtensionList'
+              required:
+                - transferAmount
+                - expiration
+                - ilpPacket
+                - condition
+            headers:
+              type: object
           required:
-            - transferAmount
-            - expiration
-            - ilpPacket
-            - condition
+            - body
+            - headers
         currentState:
           $ref: '#/components/schemas/async2SyncCurrentState'
       required:
@@ -2265,7 +2331,14 @@ components:
       type: object
       properties:
         transfer:
-          $ref: '#/components/schemas/TransfersIDPutResponse'
+          properties:
+            body:
+              $ref: '#/components/schemas/TransfersIDPutResponse'
+            headers:
+              type: object
+          required:
+            - body
+            - headers
         currentState:
           $ref: '#/components/schemas/async2SyncCurrentState'
       required:

package/src/OutboundServer/api_interfaces/openapi.d.ts

@@ -633,6 +633,8 @@ export interface components {
       note?: components["schemas"]["Note"];
       quoteRequestExtensions?: components["schemas"]["extensionListEmptiable"];
       transferRequestExtensions?: components["schemas"]["extensionListEmptiable"];
+      /** 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 has been performed. */
+      skipPartyLookup?: boolean;
     };
     /** 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 (‘-‘). */
     CorrelationId: string;
@@ -728,12 +730,24 @@ export interface components {
       note?: components["schemas"]["Note"];
       currentState?: components["schemas"]["transferStatus"];
       quoteId?: components["schemas"]["CorrelationId"];
-      quoteResponse?: components["schemas"]["QuotesIDPutResponse"];
+      getPartiesResponse?: {
+        body: { [key: string]: unknown };
+        headers?: { [key: string]: unknown };
+      };
+      quoteResponse?: {
+        body: components["schemas"]["QuotesIDPutResponse"];
+        headers?: { [key: string]: unknown };
+      };
       /** 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. */
       quoteResponseSource?: string;
-      fulfil?: components["schemas"]["TransfersIDPutResponse"];
+      fulfil?: {
+        body: components["schemas"]["TransfersIDPutResponse"];
+        headers?: { [key: string]: unknown };
+      };
       /** Object representing the last error to occur during a transfer 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. */
       lastError?: components["schemas"]["transferError"];
+      /** 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 has been performed. */
+      skipPartyLookup?: boolean;
     };
     errorResponse: {
       /** Error code as string. */
@@ -747,7 +761,10 @@ export interface components {
     transferStatusResponse: {
       transferId: components["schemas"]["CorrelationId"];
       currentState: components["schemas"]["transferStatus"];
-      fulfil: components["schemas"]["TransfersIDPutResponse"];
+      fulfil: {
+        body: components["schemas"]["TransfersIDPutResponse"];
+        headers?: { [key: string]: unknown };
+      };
     };
     transferContinuationAcceptParty: {
       acceptParty: true;
@@ -1011,6 +1028,10 @@ export interface components {
       response?: components["schemas"]["accountCreationStatus"];
       currentState?: components["schemas"]["accountsCreationState"];
       lastError?: components["schemas"]["transferError"];
+      postAccountsResponse?: {
+        body: { [key: string]: unknown };
+        headers?: { [key: string]: unknown };
+      };
     };
     errorAccountsResponse: components["schemas"]["errorResponse"] & {
       executionState: components["schemas"]["accountsResponse"];
@@ -1049,8 +1070,11 @@ export interface components {
       | "ERROR_OCCURRED";
     /** GET /parties/{Type}/{ID} response object */
     partiesByIdResponse: {
-      /** Information regarding the requested Party. */
-      party: components["schemas"]["Party"];
+      party: {
+        /** Information regarding the requested Party. */
+        body: components["schemas"]["Party"];
+        headers: { [key: string]: unknown };
+      };
       currentState: components["schemas"]["async2SyncCurrentState"];
     };
     /** The object sent in the POST /quotes request. */
@@ -1089,16 +1113,19 @@ export interface components {
     quotesPostResponse: {
       /** The object sent in the PUT /quotes/{ID} callback. */
       quotes: {
-        transferAmount: components["schemas"]["Money"];
-        payeeReceiveAmount?: components["schemas"]["Money"];
-        payeeFspFee?: components["schemas"]["Money"];
-        payeeFspCommission?: components["schemas"]["Money"];
-        /** Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. */
-        expiration: string;
-        geoCode?: components["schemas"]["GeoCode"];
-        ilpPacket: components["schemas"]["IlpPacket"];
-        condition: components["schemas"]["IlpCondition"];
-        extensionList?: components["schemas"]["ExtensionList"];
+        body: {
+          transferAmount: components["schemas"]["Money"];
+          payeeReceiveAmount?: components["schemas"]["Money"];
+          payeeFspFee?: components["schemas"]["Money"];
+          payeeFspCommission?: components["schemas"]["Money"];
+          /** Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. */
+          expiration: string;
+          geoCode?: components["schemas"]["GeoCode"];
+          ilpPacket: components["schemas"]["IlpPacket"];
+          condition: components["schemas"]["IlpCondition"];
+          extensionList?: components["schemas"]["ExtensionList"];
+        };
+        headers: { [key: string]: unknown };
       };
       currentState: components["schemas"]["async2SyncCurrentState"];
     };
@@ -1121,7 +1148,10 @@ export interface components {
       transfersPostRequest: components["schemas"]["TransfersPostRequest"];
     };
     simpleTransfersPostResponse: {
-      transfer: components["schemas"]["TransfersIDPutResponse"];
+      transfer: {
+        body: components["schemas"]["TransfersIDPutResponse"];
+        headers: { [key: string]: unknown };
+      };
       currentState: components["schemas"]["async2SyncCurrentState"];
     };
     errorSimpleTransfersResponse: components["schemas"]["errorResponse"] & {

package/src/OutboundServer/api_template/components/schemas/accountsResponse.yaml

@@ -13,3 +13,12 @@ properties:
     $ref: ./accountsCreationState.yaml
   lastError:
     $ref: ./transferError.yaml
+  postAccountsResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        type: object
+      headers:
+        type: object

package/src/OutboundServer/api_template/components/schemas/partiesByIdResponse.yaml

@@ -3,9 +3,16 @@
   description: 'GET /parties/{Type}/{ID} response object'
   properties:
     party:
-      $ref: >-
-        ../../../../../node_modules/@mojaloop/api-snippets/thirdparty/v1_0/openapi3/components/schemas/Party.yaml
-      description: Information regarding the requested Party.
+      properties:
+        body:
+          $ref: >-
+            ../../../../../node_modules/@mojaloop/api-snippets/thirdparty/v1_0/openapi3/components/schemas/Party.yaml
+          description: Information regarding the requested Party.
+        headers:
+          type: object
+      required:
+        - body
+        - headers
     currentState:
       $ref: ../schemas/async2SyncCurrentState.yaml
   required:

package/src/OutboundServer/api_template/components/schemas/quotesPostResponse.yaml

@@ -6,41 +6,49 @@ properties:
     type: object
     description: 'The object sent in the PUT /quotes/{ID} callback.'
     properties:
-      transferAmount:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
-      payeeReceiveAmount:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
-      payeeFspFee:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
-      payeeFspCommission:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
-      expiration:
-        type: string
-        description: >-
-          Date and time until when the quotation is valid and can be honored when
-          used in the subsequent transaction.
-        example: '2016-05-24T08:38:08.699-04:00'
-      geoCode:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/GeoCode.yaml
-      ilpPacket:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/IlpPacket.yaml
-      condition:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/IlpCondition.yaml
-      extensionList:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ExtensionList.yaml
+      body:
+        type: object
+        properties:
+          transferAmount:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
+          payeeReceiveAmount:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
+          payeeFspFee:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
+          payeeFspCommission:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
+          expiration:
+            type: string
+            description: >-
+              Date and time until when the quotation is valid and can be honored when
+              used in the subsequent transaction.
+            example: '2016-05-24T08:38:08.699-04:00'
+          geoCode:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/GeoCode.yaml
+          ilpPacket:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/IlpPacket.yaml
+          condition:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/IlpCondition.yaml
+          extensionList:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ExtensionList.yaml
+        required:
+          - transferAmount
+          - expiration
+          - ilpPacket
+          - condition
+      headers:
+        type: object
     required:
-      - transferAmount
-      - expiration
-      - ilpPacket
-      - condition
+    - body
+    - headers
   currentState:
     $ref: ../schemas/async2SyncCurrentState.yaml
 required:

package/src/OutboundServer/api_template/components/schemas/simpleTransfersPostResponse.yaml

@@ -2,8 +2,15 @@ title: SimpleTransfersPostResponse
 type: object
 properties:
   transfer:
-    $ref: >-
-      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransfersIDPutResponse.yaml
+    properties:
+      body:
+        $ref: >-
+          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransfersIDPutResponse.yaml
+      headers:
+        type: object
+    required:
+      - body
+      - headers
   currentState:
     $ref: ../schemas/async2SyncCurrentState.yaml
 required:

package/src/OutboundServer/api_template/components/schemas/transferRequest.yaml

@@ -35,3 +35,6 @@ properties:
     $ref: ./extensionListEmptiable.yaml
   transferRequestExtensions:
     $ref: ./extensionListEmptiable.yaml
+  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 has been performed.
+    type: boolean

package/src/OutboundServer/api_template/components/schemas/transferResponse.yaml

@@ -39,8 +39,24 @@ properties:
   quoteId:
     $ref: >-
       ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  getPartiesResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        type: object
+      headers:
+        type: object
   quoteResponse:
-    $ref: ./quote.yaml
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        $ref: './quote.yaml'
+      headers:
+        type: object
   quoteResponseSource:
     type: string
     description: >
@@ -48,7 +64,14 @@ properties:
       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: ./transferFulfilment.yaml
+      type: object
+      required:
+        - body
+      properties:
+        body:
+          $ref: ./transferFulfilment.yaml
+        headers:
+          type: object
   lastError:
     description: >
       Object representing the last error to occur during a transfer process.
@@ -56,3 +79,6 @@ properties:
       scheme or an object representing other types of error e.g. exceptions that
       may occur inside the scheme adapter.
     $ref: ./transferError.yaml
+  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 has been performed.
+    type: boolean

package/src/OutboundServer/api_template/components/schemas/transferStatusResponse.yaml

@@ -10,4 +10,11 @@ properties:
   currentState:
     $ref: ./transferStatus.yaml
   fulfil:
-    $ref: ./transferFulfilment.yaml
+      type: object
+      required:
+        - body
+      properties:
+        body:
+          $ref: ./transferFulfilment.yaml
+        headers:
+          type: object

package/src/OutboundServer/handlers.js

@@ -182,7 +182,7 @@ const putTransfers = async (ctx) => {
         // load the transfer model from cache and start it running again
         await model.load(ctx.state.path.params.transferId);
 
-        const response = await model.run();
+        const response = await model.run(ctx.request.body);
 
         // return the result
         ctx.response.status = 200;

package/src/config.js

@@ -182,5 +182,5 @@ module.exports = {
     // the `transactionId` to retrieve the quote from cache
     allowDifferentTransferTransactionId: env.get('ALLOW_DIFFERENT_TRANSFER_TRANSACTION_ID').default('false').asBool(),
 
-    pm4mlEnabled: env.get('PM4ML_ENABLED').default('false').asBool()
+    pm4mlEnabled: env.get('PM4ML_ENABLED').default('false').asBool(),
 };

package/src/lib/model/AccountsModel.js

@@ -133,20 +133,23 @@ class AccountsModel {
 
 
     async _executeCreateAccountsRequest(request) {
+        const accountRequest = request;
+
         // eslint-disable-next-line no-async-promise-executor
         return new Promise(async (resolve, reject) => {
-            const requestKey = `ac_${request.requestId}`;
+            const requestKey = `ac_${accountRequest.requestId}`;
 
             const subId = await this._cache.subscribe(requestKey, async (cn, msg, subId) => {
                 try {
                     let error;
-                    let message = JSON.parse(msg);
+                    const message = JSON.parse(msg);
+                    this._data.postAccountsResponse = message.data;
 
                     if (message.type === 'accountsCreationErrorResponse') {
-                        error = new BackendError(`Got an error response creating accounts: ${util.inspect(message.data)}`, 500);
-                        error.mojaloopError = message.data;
+                        error = new BackendError(`Got an error response creating accounts: ${util.inspect(this._data.postAccountsResponse.body)}`, 500);
+                        error.mojaloopError = this._data.postAccountsResponse.body;
                     } else if (message.type !== 'accountsCreationSuccessfulResponse') {
-                        this._logger.push({ message }).log(
+                        this._logger.push(util.inspect(this._data.postAccountsResponse)).log(
                             `Ignoring cache notification for request ${requestKey}. ` +
                             `Unknown message type ${message.type}.`
                         );
@@ -167,7 +170,7 @@ class AccountsModel {
                         return reject(error);
                     }
 
-                    const response = message.data;
+                    const response = this._data.postAccountsResponse;
                     this._logger.push({ response }).log('Account creation response received');
                     return resolve(response);
                 }
@@ -178,7 +181,7 @@ class AccountsModel {
 
             // set up a timeout for the request
             const timeout = setTimeout(() => {
-                const err = new BackendError(`Timeout waiting for response to account creation request ${request.requestId}`, 504);
+                const err = new BackendError(`Timeout waiting for response to account creation request ${accountRequest.requestId}`, 504);
 
                 // we dont really care if the unsubscribe fails but we should log it regardless
                 this._cache.unsubscribe(requestKey, subId).catch(e => {
@@ -191,7 +194,7 @@ class AccountsModel {
             // now we have a timeout handler and a cache subscriber hooked up we can fire off
             // a POST /participants request to the switch
             try {
-                const res = await this._requests.postParticipants(request);
+                const res = await this._requests.postParticipants(accountRequest);
                 this._logger.push({ res }).log('Account creation request sent to peer');
             }
             catch(err) {
@@ -218,11 +221,11 @@ class AccountsModel {
     }
 
     _buildClientResponse(response) {
-        return response.partyList.map(party => ({
+        return response.body.partyList.map(party => ({
             idType: party.partyId.partyIdType,
             idValue: party.partyId.partyIdentifier,
             idSubValue: party.partyId.partySubIdOrType,
-            ...!response.currency && {
+            ...!response.body.currency && {
                 error: {
                     statusCode: Errors.MojaloopApiErrorCodes.CLIENT_ERROR.code,
                     message: 'Provided currency not supported',
@@ -295,7 +298,6 @@ class AccountsModel {
                 resp.currentState = stateEnum.ERROR_OCCURRED;
                 break;
         }
-
         return resp;
     }