@mojaloop/sdk-scheme-adapter 11.18.8

package/OutboundServer/api_template/components/schemas/bulkTransferRequest.yaml

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

package/OutboundServer/api_template/components/schemas/bulkTransferResponse.yaml

@@ -0,0 +1,16 @@
+type: object
+required:
+  - from
+  - individualTransferResults
+properties:
+  transferId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  from:
+    $ref: ./transferParty.yaml
+  individualTransferResults:
+    type: array
+    maxItems: 1000
+    items:
+      $ref: ./individualTransferResult.yaml
+    description: List of individual transfer result in a bulk transfer response.

package/OutboundServer/api_template/components/schemas/bulkTransferStatus.yaml

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

package/OutboundServer/api_template/components/schemas/bulkTransferStatusResponse.yaml

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

package/OutboundServer/api_template/components/schemas/errorAccountsResponse.yaml

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object
+    required:
+      - executionState
+    properties:
+      executionState:
+        $ref: ./accountsResponse.yaml

package/OutboundServer/api_template/components/schemas/errorAuthorizationsResponse.yaml

@@ -0,0 +1,3 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object

package/OutboundServer/api_template/components/schemas/errorQuotesResponse.yaml

@@ -0,0 +1,9 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object
+    # TODO: refactor to have proper response
+    # required:
+    #   - transferState
+    # properties:
+    #   currentState:
+    #     $ref: ./transferResponse.yaml

package/OutboundServer/api_template/components/schemas/errorResponse.yaml

@@ -0,0 +1,8 @@
+type: object
+properties:
+  statusCode:
+    type: string
+    description: Error code as string.
+  message:
+    type: string
+    description: Error message text.

package/OutboundServer/api_template/components/schemas/errorSimpleTransfersResponse.yaml

@@ -0,0 +1,3 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object

package/OutboundServer/api_template/components/schemas/errorTransferResponse.yaml

@@ -0,0 +1,8 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object
+    required:
+      - transferState
+    properties:
+      transferState:
+        $ref: ./transferResponse.yaml

package/OutboundServer/api_template/components/schemas/extensionListEmptiable.yaml

@@ -0,0 +1,6 @@
+type: array
+items:
+  $ref: >-
+    ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Extension.yaml
+minItems: 0
+maxItems: 16

package/OutboundServer/api_template/components/schemas/individualQuote.yaml

@@ -0,0 +1,32 @@
+title: IndividualQuote
+type: object
+description: Data model for the complex type 'individualQuote'.
+properties:
+  quoteId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
+  currency:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
+  amount:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
+  transactionType:
+    $ref: ./transactionType.yaml
+  note:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
+  extensions:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ExtensionList.yaml
+required:
+  - quoteId
+  - to
+  - amountType
+  - currency
+  - transactionType

package/OutboundServer/api_template/components/schemas/individualQuoteResult.yaml

@@ -0,0 +1,28 @@
+type: object
+properties:
+  quoteId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
+  currency:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
+  amount:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
+  transactionType:
+    $ref: ./transactionType.yaml
+  note:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
+  lastError:
+    description: >
+      Object representing the last error to occur during a quote 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: ./quoteError.yaml

package/OutboundServer/api_template/components/schemas/individualTransfer.yaml

@@ -0,0 +1,32 @@
+title: IndividualTransfer
+type: object
+description: Data model for the complex type 'individualTransfer'.
+properties:
+  transferId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
+  currency:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
+  amount:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
+  transactionType:
+    $ref: ./transactionType.yaml
+  note:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
+  extensions:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ExtensionList.yaml
+required:
+  - transferId
+  - to
+  - amountType
+  - currency
+  - transactionType

package/OutboundServer/api_template/components/schemas/individualTransferFulfilment.yaml

@@ -0,0 +1,13 @@
+type: object
+description: A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer
+properties:
+  fulfilment:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/IlpFulfilment.yaml
+    description: >
+      Fulfilment of the condition specified with the transaction. Mandatory if
+      transfer has completed successfully.
+  extensionList:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ExtensionList.yaml
+    description: 'Optional extension, specific to deployment.'

package/OutboundServer/api_template/components/schemas/individualTransferResult.yaml

@@ -0,0 +1,41 @@
+type: object
+properties:
+  transferId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
+  currency:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
+  amount:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
+  transactionType:
+    $ref: ./transactionType.yaml
+  note:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
+  quoteId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  quoteResponse:
+    $ref: ./quote.yaml
+  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: ./transferFulfilment.yaml
+  lastError:
+    description: >
+      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.
+    $ref: ./transferError.yaml

package/OutboundServer/api_template/components/schemas/mojaloopError.yaml

@@ -0,0 +1,5 @@
+type: object
+properties:
+  errorInformation:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ErrorInformation.yaml

package/OutboundServer/api_template/components/schemas/mojaloopTransactionRequestState.yaml

@@ -0,0 +1,2 @@
+$ref: >-
+  ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransactionRequestState.yaml

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

@@ -0,0 +1,13 @@
+  title: partiesByIdResponse
+  type: object
+  description: 'GET /parties/{Type}/{ID} response object'
+  properties:
+    party:
+      $ref: >-
+        ../../../../node_modules/@mojaloop/api-snippets/thirdparty/openapi3/components/schemas/Party.yaml
+      description: Information regarding the requested Party.
+    currentState:
+      $ref: ../schemas/async2SyncCurrentState.yaml
+  required:
+    - party
+    - currentState

package/OutboundServer/api_template/components/schemas/quote.yaml

@@ -0,0 +1,3 @@
+description: Mojaloop API response to a quote request
+$ref: >-
+  ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/QuotesIDPutResponse.yaml

package/OutboundServer/api_template/components/schemas/quoteError.yaml

@@ -0,0 +1,16 @@
+type: object
+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.
+  mojaloopError:
+    description: >-
+      If a quote process results in an error callback during the asynchronous
+      Mojaloop API exchange, this property will contain the underlying Mojaloop
+      API error object.
+    $ref: ./mojaloopError.yaml

package/OutboundServer/api_template/components/schemas/quotesPostRequest.yaml

@@ -0,0 +1,13 @@
+title: QuotesPostRequest
+type: object
+properties:
+  fspId: 
+    title: destination DFSP requested to calculate the quote
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/FspId.yaml
+  quotesPostRequest:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/thirdparty/openapi3/components/schemas/QuotesPostRequest.yaml
+required: 
+  - fspId
+  - quotesPostRequest

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

@@ -0,0 +1,48 @@
+title: QuotesPostResponse
+type: object
+properties:
+  quotes:
+    title: QuotesIDPutResponse
+    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
+    required:
+      - transferAmount
+      - expiration
+      - ilpPacket
+      - condition
+  currentState:
+    $ref: ../schemas/async2SyncCurrentState.yaml
+required: 
+  - quotes
+  - currentState

package/OutboundServer/api_template/components/schemas/requestToPayRequest.yaml

@@ -0,0 +1,39 @@
+type: object
+required:
+  - homeTransactionId
+  - from
+  - to
+  - amountType
+  - currency
+  - amount
+  - scenario
+  - initiator
+  - initiatorType
+properties:
+  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
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
+  currency:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
+  amount:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
+  scenario:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransactionType.yaml
+  initiator:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransactionInitiator.yaml
+  initiatorType:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransactionInitiatorType.yaml

package/OutboundServer/api_template/components/schemas/requestToPayResponse.yaml

@@ -0,0 +1,41 @@
+type: object
+required:
+  - transactionRequestId
+  - from
+  - to
+  - amountType
+  - currency
+  - amount
+  - transactionType
+  - requestToPayState
+properties:
+  transactionRequestId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  from:
+    $ref: ./transferParty.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AmountType.yaml
+  currency:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Currency.yaml
+  amount:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Amount.yaml
+  scenario:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransactionType.yaml
+  initiator:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransactionInitiator.yaml
+  initiatorType:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransactionInitiatorType.yaml
+  authenticationType:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/AuthenticationType.yaml
+  requestToPayState:
+    $ref: ./mojaloopTransactionRequestState.yaml