@mojaloop/api-snippets 14.0.0 → 14.2.1

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkQuoteStatusResponse.yaml

@@ -0,0 +1,16 @@
+type: object
+required:
+  - bulkQuoteId
+  - currentState
+  - individualQuotes
+properties:
+  bulkQuoteId:
+    $ref: ./CorrelationId.yaml
+  currentState:
+    $ref: ./bulkQuoteStatus.yaml
+  individualQuotes:
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ./individualQuote.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionAcceptPartyErrorResponse.yaml

@@ -0,0 +1,10 @@
+allOf:
+  - $ref: ./errorResponse.yaml
+  - type: object
+    required:
+      - bulkTransferState
+    properties:
+      bulkTransferState:
+        allOf:
+          - $ref: ./bulkTransactionContinuationAcceptParty.yaml
+          - $ref: ./partyError.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionAcceptQuoteErrorResponse.yaml

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

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionContinuationAcceptParty.yaml

@@ -0,0 +1,24 @@
+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: ./individualTransactionAccept.yaml
+        - $ref: ./transferContinuationAcceptParty.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionContinuationAcceptQuote.yaml

@@ -0,0 +1,20 @@
+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: ./individualTransactionAccept.yaml
+        - $ref: ./transferContinuationAcceptQuote.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionOptions.yaml

@@ -0,0 +1,35 @@
+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: ./autoAcceptPartyOption.yaml
+  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: ./autoAcceptQuote.yaml
+  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: ./DateTime.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionRequest.yaml

@@ -0,0 +1,27 @@
+type: object
+required:
+  - bulkHomeTransactionID
+  - options
+  - from
+  - individualTransfers
+properties:
+  bulkHomeTransactionID:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  bulkTransactionId:
+    $ref: ./CorrelationId.yaml
+  options:
+    $ref: ./bulkTransactionOptions.yaml
+  from:
+    $ref: ./Party.yaml
+  individualTransfers:
+    description: List of individual transfers in a bulk transfer.
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ./individualTransaction.yaml
+  extensions:
+    $ref: ./ExtensionList.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionResponse.yaml

@@ -0,0 +1,27 @@
+type: object
+required:
+  - bulkHomeTransactionID
+  - bulkTransactionId
+  - currentState
+  - individualTransferResults
+properties:
+  bulkHomeTransactionID:
+    type: string
+    description: >-
+      Transaction ID from the DFSP backend, used to reconcile transactions
+      between the Switch and DFSP backend systems.
+  bulkTransactionId:
+    $ref: ./CorrelationId.yaml
+  currentState:
+    $ref: ./bulkTransactionStatus.yaml
+  options:
+    $ref: ./bulkTransactionOptions.yaml
+  individualTransferResults:
+    description: List of individual transfer result in a bulk transfer response.
+    type: array
+    minItems: 1
+    maxItems: 1000
+    items:
+      $ref: ./individualTransactionResult.yaml
+  extensions:
+    $ref: ./ExtensionList.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionStatus.yaml

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

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferErrorResponse.yaml

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

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferRequest.yaml

@@ -0,0 +1,24 @@
+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: ./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: ./ExtensionList.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferResponse.yaml

@@ -0,0 +1,15 @@
+type: object
+required:
+- from
+- individualTransferResults
+properties:
+  transferId:
+    $ref: ./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/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferStatus.yaml

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

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/errorAccountsResponse.yaml

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

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/errorQuotesResponse.yaml

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

package/sdk-scheme-adapter/outbound/v2_0_0/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/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/errorSimpleTransfersResponse.yaml

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

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/errorTransferResponse.yaml

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

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/extensionListEmptiable.yaml

@@ -0,0 +1,5 @@
+type: array
+items:
+  $ref: ./Extension.yaml
+minItems: 0
+maxItems: 16

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuote.yaml

@@ -0,0 +1,26 @@
+title: IndividualQuote
+type: object
+description: Data model for the complex type 'individualQuote'.
+properties:
+  quoteId:
+    $ref: ./CorrelationId.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  transactionType:
+    $ref: ./TransactionType.yaml
+  note:
+    $ref: ./Note.yaml
+  extensions:
+    $ref: ./ExtensionList.yaml
+required:
+  - quoteId
+  - to
+  - amountType
+  - currency
+  - transactionType

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuoteResult.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  quoteId:
+    $ref: ./CorrelationId.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  transactionType:
+    $ref: ./TransactionType.yaml
+  note:
+    $ref: ./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/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransaction.yaml

@@ -0,0 +1,31 @@
+title: IndividualTransaction
+type: object
+description: Data model for the complex type 'individualTransaction'.
+properties:
+  homeTransactionId:
+    $ref: ./CorrelationId.yaml
+  to:
+    $ref: ./Party.yaml
+  reference:
+    description: Payer Loan reference
+    type: string
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  note:
+    $ref: ./Note.yaml
+  quoteExtensions:
+    $ref: ./ExtensionList.yaml
+  transferExtensions:
+    $ref: ./ExtensionList.yaml
+  lastError:
+    $ref: ./transferError.yaml
+required:
+  - homeTransactionId
+  - to
+  - amountType
+  - currency
+  - amount

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransactionAccept.yaml

@@ -0,0 +1,10 @@
+type: object
+description: Data model for the 'individualTransfer' while accepting party or quote.
+properties:
+  homeTransactionId:
+    $ref: ./CorrelationId.yaml
+  transactionId:
+    $ref: ./CorrelationId.yaml
+required:
+  - homeTransactionId
+  - transactionId

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransactionResult.yaml

@@ -0,0 +1,37 @@
+type: object
+required:
+  - homeTransactionId
+  - transactionId
+  - to
+  - amountType
+  - currency
+  - amount
+properties:
+  transferId:
+    $ref: ./CorrelationId.yaml
+  homeTransactionId:
+    $ref: ./CorrelationId.yaml
+  transactionId:
+    $ref: ./CorrelationId.yaml
+  to:
+    $ref: ./Party.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  note:
+    $ref: ./Note.yaml
+  quoteId:
+    $ref: ./CorrelationId.yaml
+  quoteResponse:
+    $ref: ./QuotesIDPutResponse.yaml
+  fulfil:
+    $ref: ./TransfersIDPutResponse.yaml
+  quoteExtensions:
+    $ref: ./ExtensionList.yaml
+  transferExtensions:
+    $ref: ./ExtensionList.yaml
+  lastError:
+    $ref: ./transferError.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransfer.yaml

@@ -0,0 +1,26 @@
+title: IndividualTransfer
+type: object
+description: Data model for the complex type 'individualTransfer'.
+properties:
+  transferId:
+    $ref: ./CorrelationId.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  transactionType:
+    $ref: ./TransactionType.yaml
+  note:
+    $ref: ./Note.yaml
+  extensions:
+    $ref: ./ExtensionList.yaml
+required:
+  - transferId
+  - to
+  - amountType
+  - currency
+  - amount

package/sdk-scheme-adapter/outbound/v2_0_0/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: ./IlpFulfilment.yaml
+    description: >
+      Fulfilment of the condition specified with the transaction.
+      Mandatory if transfer has completed successfully.
+  extensionList:
+    $ref: ./ExtensionList.yaml
+    description: 'Optional extension, specific to deployment.'

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransferResult.yaml

@@ -0,0 +1,37 @@
+type: object
+required:
+  - transactionId
+  - to
+  - amountType
+  - currency
+  - amount
+properties:
+  transferId:
+    $ref: ./CorrelationId.yaml
+  to:
+    $ref: ./transferParty.yaml
+  amountType:
+    $ref: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  transactionType:
+    $ref: ./TransactionType.yaml
+  note:
+    $ref: ./Note.yaml
+  quoteId:
+    $ref: ./CorrelationId.yaml
+  quoteResponse:
+    $ref: ./QuotesIDPutResponse.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: ./TransfersIDPutResponse.yaml
+  lastError:
+    $ref: ./transferError.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/mojaloopError.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  errorInformation:
+    $ref: ./ErrorInformation.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/partiesByIdResponse.yaml

@@ -0,0 +1,19 @@
+title: partiesByIdResponse
+type: object
+description: GET /parties/{Type}/{ID} response object
+properties:
+  party:
+    properties:
+      body:
+        $ref: ./Party.yaml
+        description: Information regarding the requested Party.
+      headers:
+        type: object
+    required:
+      - body
+      - headers
+  currentState:
+    $ref: ./async2SyncCurrentState.yaml
+required:
+  - party
+  - currentState

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/partyError.yaml

@@ -0,0 +1,16 @@
+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: ./mojaloopError.yaml

package/sdk-scheme-adapter/outbound/v2_0_0/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/sdk-scheme-adapter/outbound/v2_0_0/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:
+      body:
+        type: object
+        properties:
+          transferAmount:
+            $ref: ./Money.yaml
+          payeeReceiveAmount:
+            $ref: ./Money.yaml
+          payeeFspFee:
+            $ref: ./Money.yaml
+          payeeFspCommission:
+            $ref: ./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: ./GeoCode.yaml
+          ilpPacket:
+            $ref: ./IlpPacket.yaml
+          condition:
+            $ref: ./IlpCondition.yaml
+          extensionList:
+            $ref: ./ExtensionList.yaml
+        required:
+          - transferAmount
+          - expiration
+          - ilpPacket
+          - condition
+      headers:
+        type: object
+    required:
+      - body
+      - headers
+  currentState:
+    $ref: ./async2SyncCurrentState.yaml
+required:
+  - quotes
+  - currentState

package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/requestToPayRequest.yaml

@@ -0,0 +1,33 @@
+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: ./AmountType.yaml
+  currency:
+    $ref: ./Currency.yaml
+  amount:
+    $ref: ./Amount.yaml
+  scenario:
+    $ref: ./TransactionType.yaml
+  initiator:
+    $ref: ./TransactionInitiator.yaml
+  initiatorType:
+    $ref: ./TransactionInitiatorType.yaml