npm - @mojaloop/sdk-scheme-adapter - Versions diffs - 11.18.8 - Mend

@mojaloop/sdk-scheme-adapter 11.18.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (277) hide show

package/OutboundServer/api_template/components/parameters/bulkQuoteId.yaml ADDED Viewed

@@ -0,0 +1,9 @@
+name: bulkQuoteId
+in: path
+required: true
+schema:
+  $ref: >-
+    ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+description: >-
+  Identifier of the bulk transfer to continue as returned in the response to a
+  `POST /bulkTransfers` request.

package/OutboundServer/api_template/components/parameters/bulkTransferId.yaml ADDED Viewed

@@ -0,0 +1,9 @@
+name: bulkTransferId
+in: path
+required: true
+schema:
+  $ref: >-
+    ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+description: >-
+  Identifier of the bulk transfer to continue as returned in the response to a
+  `POST /bulkTransfers` request.

package/OutboundServer/api_template/components/parameters/requestToPayTransactionId.yaml ADDED Viewed

@@ -0,0 +1,9 @@
+name: requestToPayTransactionId
+in: path
+required: true
+schema:
+  $ref: >-
+    ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+description: >-
+  Identifier of the merchant request to pay transfer to continue as returned in
+  the response to a `POST /requestToPayTransfer` request.

package/OutboundServer/api_template/components/parameters/transferId.yaml ADDED Viewed

@@ -0,0 +1,9 @@
+name: transferId
+in: path
+required: true
+schema:
+  $ref: >-
+    ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+description: >-
+  Identifier of the transfer to continue as returned in the response to a `POST
+  /transfers` request.

package/OutboundServer/api_template/components/responses/accountsCreationCompleted.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Accounts creation completed
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/accountsResponse.yaml

package/OutboundServer/api_template/components/responses/accountsCreationError.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: An error occurred creating accounts
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorAccountsResponse.yaml

package/OutboundServer/api_template/components/responses/accountsCreationTimeout.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Timeout occurred creating accounts
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorAccountsResponse.yaml

package/OutboundServer/api_template/components/responses/authorizationPostSuccess.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Sync response from POST /authorizations
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/authorizationsPostResponse.yaml

package/OutboundServer/api_template/components/responses/authorizationsServerError.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: An error occurred processing the authorizations request
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorAuthorizationsResponse.yaml

package/OutboundServer/api_template/components/responses/bulkQuoteBadRequest.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: 'Malformed or missing required body, headers or parameters'
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkQuoteErrorResponse.yaml

package/OutboundServer/api_template/components/responses/bulkQuoteServerError.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: An error occurred processing the bulk quote
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkQuoteErrorResponse.yaml

package/OutboundServer/api_template/components/responses/bulkQuoteSuccess.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Bulk quote completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkQuoteResponse.yaml

package/OutboundServer/api_template/components/responses/bulkQuoteTimeout.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Timeout occurred processing the bulk quote
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkQuoteErrorResponse.yaml

package/OutboundServer/api_template/components/responses/bulkTransferBadRequest.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: 'Malformed or missing required body, headers or parameters'
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkTransferErrorResponse.yaml

package/OutboundServer/api_template/components/responses/bulkTransferServerError.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: An error occurred processing the bulk transfer
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkTransferErrorResponse.yaml

package/OutboundServer/api_template/components/responses/bulkTransferSuccess.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Bulk transfer completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkTransferResponse.yaml

package/OutboundServer/api_template/components/responses/bulkTransferTimeout.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Timeout occurred processing the bulk transfer
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/bulkTransferErrorResponse.yaml

package/OutboundServer/api_template/components/responses/partiesByIdError404.yaml ADDED Viewed

@@ -0,0 +1,9 @@
+description:  PartiesByIdError404
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        errorInformation:
+          $ref: >-
+            ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ErrorInformation.yaml

package/OutboundServer/api_template/components/responses/partiesByIdSuccess.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description:  PartiesByIdSuccess
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/partiesByIdResponse.yaml

package/OutboundServer/api_template/components/responses/quotesPostSuccess.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: sync response from POST /quotes
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/quotesPostResponse.yaml

package/OutboundServer/api_template/components/responses/quotesServerError.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: An error occurred processing the quotes request
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorQuotesResponse.yaml

package/OutboundServer/api_template/components/responses/requestToPaySuccess.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Request to Pay completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/requestToPayResponse.yaml

package/OutboundServer/api_template/components/responses/requestToPayTransferBadRequest.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: 'Malformed or missing required body, headers or parameters'
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorTransferResponse.yaml

package/OutboundServer/api_template/components/responses/requestToPayTransferSuccess.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Transfer completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/requestToPayTransferResponse.yaml

package/OutboundServer/api_template/components/responses/simpleTransfersPostSuccess.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: sync response from POST /simpleTransfers
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/simpleTransfersPostResponse.yaml

package/OutboundServer/api_template/components/responses/simpleTransfersServerError.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: An error occurred processing the simple transfers request
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorSimpleTransfersResponse.yaml

package/OutboundServer/api_template/components/responses/transferBadRequest.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: 'Malformed or missing required body, headers or parameters'
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorTransferResponse.yaml

package/OutboundServer/api_template/components/responses/transferServerError.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: An error occurred processing the transfer
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorTransferResponse.yaml

package/OutboundServer/api_template/components/responses/transferSuccess.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Transfer completed successfully
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/transferResponse.yaml

package/OutboundServer/api_template/components/responses/transferTimeout.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+description: Timeout occurred processing the transfer
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/errorTransferResponse.yaml

package/OutboundServer/api_template/components/schemas/accountCreationStatus.yaml ADDED Viewed

@@ -0,0 +1,18 @@
+type: array
+items:
+  type: object
+  required:
+    - idType
+    - idValue
+  properties:
+    idType:
+      $ref: >-
+        ../../../../node_modules/@mojaloop/api-snippets/thirdparty/openapi3/components/schemas/PartyIdType.yaml
+    idValue:
+      $ref: >-
+        ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/PartyIdentifier.yaml
+    idSubValue:
+      $ref: >-
+        ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/PartySubIdOrType.yaml
+    error:
+      $ref: ./errorResponse.yaml

package/OutboundServer/api_template/components/schemas/accountsCreationState.yaml ADDED Viewed

@@ -0,0 +1,4 @@
+type: string
+enum:
+  - ERROR_OCCURRED
+  - COMPLETED

package/OutboundServer/api_template/components/schemas/accountsRequest.yaml ADDED Viewed

@@ -0,0 +1,20 @@
+type: array
+items:
+  type: object
+  required:
+    - idType
+    - idValue
+    - currency
+  properties:
+    idType:
+      $ref: >-
+        ../../../../node_modules/@mojaloop/api-snippets/thirdparty/openapi3/components/schemas/PartyIdType.yaml
+    idValue:
+      $ref: >-
+        ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/PartyIdentifier.yaml
+    idSubValue:
+      $ref: >-
+        ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/PartySubIdOrType.yaml
+    currency:
+      $ref: >-
+        ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml

package/OutboundServer/api_template/components/schemas/accountsResponse.yaml ADDED Viewed

@@ -0,0 +1,15 @@
+type: object
+required:
+  - accounts
+properties:
+  modelId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  accounts:
+    $ref: ./accountsRequest.yaml
+  response:
+    $ref: ./accountCreationStatus.yaml
+  currentState:
+    $ref: ./accountsCreationState.yaml
+  lastError:
+    $ref: ./transferError.yaml

package/OutboundServer/api_template/components/schemas/async2SyncCurrentState.yaml ADDED Viewed

@@ -0,0 +1,5 @@
+type: string
+enum:
+  - 'WAITING_FOR_ACTION'
+  - 'COMPLETED'
+  - 'ERROR_OCCURRED'

package/OutboundServer/api_template/components/schemas/authorizationsPostRequest.yaml ADDED Viewed

@@ -0,0 +1,15 @@
+title: AuthorizationsPostRequest
+description: POST /authorizations Request object
+type: object
+properties:
+  fspId:
+    title: destination DFSP
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/FspId.yaml
+  authorizationsPostRequest:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/thirdparty/openapi3/components/schemas/AuthorizationsPostRequest.yaml
+required:
+  - fspId
+  - authorizationsPostRequest

package/OutboundServer/api_template/components/schemas/authorizationsPostResponse.yaml ADDED Viewed

@@ -0,0 +1,19 @@
+title: AuthorizationsPostResponse
+description: POST /authorizations response object
+type: object
+properties:
+  authorizations:
+    type: object
+    properties:
+      authenticationInfo:
+        $ref: '../../../../node_modules/@mojaloop/api-snippets/thirdparty/openapi3/components/schemas/AuthenticationInfo.yaml'
+      responseType:
+        $ref: '../../../../node_modules/@mojaloop/api-snippets/thirdparty/openapi3/components/schemas/AuthorizationResponseType.yaml'
+    required:
+      - responseType
+  currentState:
+    $ref: ../schemas/async2SyncCurrentState.yaml
+required:
+  - authorizations
+  - currentState
+additionalProperties: false

package/OutboundServer/api_template/components/schemas/bulkQuoteErrorResponse.yaml ADDED Viewed

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object
+    required:
+      - bulkTansferState
+    properties:
+      bulkQuoteState:
+        $ref: ./bulkQuoteResponse.yaml

package/OutboundServer/api_template/components/schemas/bulkQuoteRequest.yaml ADDED Viewed

@@ -0,0 +1,26 @@
+type: object
+required:
+  - homeTransactionId
+  - from
+  - individualQuotes
+properties:
+  homeTransactionId:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  bulkQuoteId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  from:
+    $ref: ./transferParty.yaml
+  individualQuotes:
+    description: List of individual quotes in a bulk quote.
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ./individualQuote.yaml
+  extensions:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ExtensionList.yaml

package/OutboundServer/api_template/components/schemas/bulkQuoteResponse.yaml ADDED Viewed

@@ -0,0 +1,21 @@
+type: object
+required:
+  - from
+  - individualQuoteResults
+properties:
+  quoteId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  homeTransactionId:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  from:
+    $ref: ./transferParty.yaml
+  individualQuoteResults:
+    type: array
+    maxItems: 1000
+    items:
+      $ref: ./individualQuoteResult.yaml
+    description: List of individualQuoteResults in a bulk transfer response.

package/OutboundServer/api_template/components/schemas/bulkQuoteStatus.yaml ADDED Viewed

@@ -0,0 +1,4 @@
+type: string
+enum:
+  - ERROR_OCCURRED
+  - COMPLETED

package/OutboundServer/api_template/components/schemas/bulkQuoteStatusResponse.yaml ADDED Viewed

@@ -0,0 +1,17 @@
+type: object
+required:
+  - bulkQuoteId
+  - currentState
+  - individualQuotes
+properties:
+  bulkQuoteId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  currentState:
+    $ref: ./bulkQuoteStatus.yaml
+  individualQuotes:
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ./individualQuote.yaml

package/OutboundServer/api_template/components/schemas/bulkTransferErrorResponse.yaml ADDED Viewed

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object
+    required:
+      - bulkTansferState
+    properties:
+      bulkTransferState:
+        $ref: ./bulkTransferResponse.yaml