@mojaloop/sdk-scheme-adapter 11.18.8

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

@@ -0,0 +1,42 @@
+type: object
+required:
+  - requestToPayTransactionId
+  - from
+  - to
+  - amountType
+  - currency
+  - amount
+  - scenario
+  - initiator
+  - initiatorType
+properties:
+  requestToPayTransactionId:
+    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
+  note:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml

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

@@ -0,0 +1,58 @@
+type: object
+required:
+  - requestToPayTransactionId
+  - from
+  - to
+  - amountType
+  - currency
+  - amount
+  - transactionType
+properties:
+  transferId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  requestToPayTransactionId:
+    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
+  transactionType:
+    $ref: ./transactionType.yaml
+  note:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
+  currentState:
+    $ref: ./transferStatus.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/simpleTransferServerError.yaml

@@ -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/schemas/simpleTransfersPostRequest.yaml

@@ -0,0 +1,12 @@
+title: SimpleTransfersPostRequest
+type: object
+properties:
+  fspId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/FspId.yaml
+  transfersPostRequest:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransfersPostRequest.yaml
+required:
+  - fspId
+  - transfersPostRequest

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

@@ -0,0 +1,11 @@
+title: SimpleTransfersPostResponse
+type: object
+properties:
+  transfer:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransfersIDPutResponse.yaml
+  currentState:
+    $ref: ../schemas/async2SyncCurrentState.yaml
+required:
+  - transfer
+  - currentState

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

@@ -0,0 +1,4 @@
+type: string
+enum:
+  - TRANSFER
+description: Type of transaction.

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

@@ -0,0 +1,9 @@
+type: object
+required:
+  - acceptOTP
+properties:
+  acceptOTP:
+    type: boolean
+    enum:
+      - true
+      - false

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

@@ -0,0 +1,8 @@
+type: object
+required:
+  - acceptParty
+properties:
+  acceptParty:
+    type: boolean
+    enum:
+      - true

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

@@ -0,0 +1,9 @@
+type: object
+required:
+  - acceptQuote
+properties:
+  acceptQuote:
+    type: boolean
+    enum:
+      - true
+      - false

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

@@ -0,0 +1,16 @@
+type: object
+description: >-
+  This object represents a Mojaloop API error received at any time during the
+  transfer 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: ./mojaloopError.yaml

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

@@ -0,0 +1,3 @@
+description: A Mojaloop API transfer fulfilment
+$ref: >-
+  ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransfersIDPutResponse.yaml

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

@@ -0,0 +1,40 @@
+type: object
+required:
+  - idType
+  - idValue
+properties:
+  type:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransactionInitiatorType.yaml
+  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
+  displayName:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Name.yaml
+  firstName:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/FirstName.yaml
+  middleName:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/MiddleName.yaml
+  lastName:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/LastName.yaml
+  dateOfBirth:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/DateOfBirth.yaml
+  merchantClassificationCode:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/MerchantClassificationCode.yaml
+  fspId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/FspId.yaml
+  extensionList:
+    $ref: ./extensionListEmptiable.yaml

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

@@ -0,0 +1,37 @@
+type: object
+required:
+  - homeTransactionId
+  - from
+  - to
+  - amountType
+  - currency
+  - amount
+  - transactionType
+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
+  transactionType:
+    $ref: ./transactionType.yaml
+  note:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Note.yaml
+  quoteRequestExtensions:
+    $ref: ./extensionListEmptiable.yaml
+  transferRequestExtensions:
+    $ref: ./extensionListEmptiable.yaml

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

@@ -0,0 +1,58 @@
+type: object
+required:
+  - homeTransactionId
+  - from
+  - to
+  - amountType
+  - currency
+  - amount
+  - transactionType
+properties:
+  transferId:
+    $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
+  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
+  currentState:
+    $ref: ./transferStatus.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/transferStatus.yaml

@@ -0,0 +1,6 @@
+type: string
+enum:
+  - ERROR_OCCURRED
+  - WAITING_FOR_PARTY_ACCEPTANCE
+  - WAITING_FOR_QUOTE_ACCEPTANCE
+  - COMPLETED

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

@@ -0,0 +1,13 @@
+type: object
+required:
+  - transferId
+  - currentState
+  - fulfil
+properties:
+  transferId:
+    $ref: >-
+      ../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  currentState:
+    $ref: ./transferStatus.yaml
+  fulfil:
+    $ref: ./transferFulfilment.yaml

package/OutboundServer/api_template/health.yaml

@@ -0,0 +1,12 @@
+get:
+  summary: Health check endpoint
+  description: >-
+    This endpoint allows a user of the SDK scheme adapter to check the outbound
+    transfers service is listening.
+  tags:
+    - Health
+  responses:
+    '200':
+      description: >-
+        Returns empty body if the scheme adapter outbound transfers service is
+        running.

package/OutboundServer/api_template/openapi.yaml

@@ -0,0 +1,55 @@
+openapi: 3.0.1
+info:
+  title: Mojaloop SDK Outbound Scheme Adapter API
+  description: >
+    Specification for the Mojaloop SDK Scheme Adapter Outbound Transfers API
+
+
+    This API can be used by DFSP backends to simplify the process of sending
+    funds to other parties within a Mojaloop scheme.
+
+
+    Please see other documentation on
+    https://github.com/mojaloop/sdk-scheme-adapter for more information.
+
+
+    **Note on terminology:** The term "Switch" is equal to the term "Hub", and
+    the term "FSP" is equal to the term "DFSP".
+  license:
+    name: 'Apache License Version 2.0, January 2004'
+    url: 'http://www.apache.org/licenses/'
+  version: 1.0.0
+paths:
+  '/':
+    $ref: health.yaml
+  '/transfers':
+    $ref: paths/transfers.yaml
+  '/transfers/{transferId}':
+    $ref: 'paths/transfers_transferId.yaml'
+  '/bulkTransfers':
+    $ref: paths/bulkTransfers.yaml
+  '/bulkTransfers/{bulkTransferId}':
+    $ref: 'paths/bulkTransfers_bulkTransferId.yaml'
+  '/bulkQuotes':
+    $ref: paths/bulkQuotes.yaml
+  '/bulkQuotes/{bulkQuoteId}':
+    $ref: 'paths/bulkQuotes_bulkQuoteId.yaml'
+  '/requestToPay':
+    $ref: paths/requestToPay.yaml
+  '/requestToPayTransfer':
+    $ref: paths/requestToPayTransfer.yaml
+  '/requestToPayTransfer/{requestToPayTransactionId}':
+    $ref: 'paths/requestToPayTransfer_requestToPayTransactionId.yaml'
+  '/accounts':
+    $ref: paths/accounts.yaml
+  '/parties/{Type}/{ID}':
+    $ref: 'paths/parties_Type_ID.yaml'
+  '/parties/{Type}/{ID}/{SubId}':
+    $ref: 'paths/parties_Type_ID_SubId.yaml'
+  '/quotes':
+    $ref: 'paths/quotes.yaml'
+  '/simpleTransfers':
+    $ref: 'paths/simpleTransfers.yaml'
+  '/authorizations':
+     $ref: 'paths/authorizations.yaml'
+

package/OutboundServer/api_template/paths/accounts.yaml

@@ -0,0 +1,26 @@
+post:
+  summary: Create accounts on the Account Lookup Service
+  description: >-
+    The HTTP request `POST /accounts` is used to create account information on
+    the Account Lookup Service (ALS) regarding the provided list of identities.
+
+
+    Caller DFSP is used as the account source FSP information
+  tags:
+    - Accounts
+  requestBody:
+    description: Identities list request body
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/accountsRequest.yaml
+    required: true
+  responses:
+    '200':
+      $ref: ../components/responses/accountsCreationCompleted.yaml
+    '400':
+      $ref: ../components/responses/accountsCreationError.yaml
+    '500':
+      $ref: ../components/responses/accountsCreationError.yaml
+    '504':
+      $ref: ../components/responses/accountsCreationTimeout.yaml