@mojaloop/api-snippets 17.3.0-snapshot.0 → 17.3.0

package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransferAccept.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransferResult.yaml

@@ -1,38 +0,0 @@
-type: object
-required:
-  - homeTransactionId
-properties:
-  transferId:
-    $ref: ./CorrelationId.yaml
-  homeTransactionId:
-    type: string
-    description: >-
-      Transaction ID from the DFSP backend, used to reconcile transactions
-      between the Switch and DFSP backend systems.
-  transactionId:
-    $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
-  quoteId:
-    $ref: ./CorrelationId.yaml
-  quoteResponse:
-    $ref: ./individualQuoteResult.yaml
-  fulfil:
-    $ref: ./individualTransferResult.yaml
-  quoteExtensions:
-    $ref: ./ExtensionList.yaml
-  transferExtensions:
-    $ref: ./ExtensionList.yaml
-  lastError:
-    $ref: ./transferError.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionOptions.yaml

@@ -1,35 +0,0 @@
-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/v2_1_0/components/schemas/bulkTransactionRequest.yaml

@@ -1,27 +0,0 @@
-type: object
-required:
-  - bulkTransactionId
-  - 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
-    items:
-      $ref: ./bulkTransactionIndividualTransfer.yaml
-  extensions:
-    $ref: ./ExtensionList.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionResponse.yaml

@@ -1,27 +0,0 @@
-title: BulkTransactionResponse
-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
-    items:
-      $ref: ./bulkTransactionIndividualTransferResult.yaml
-  extensions:
-    $ref: ./ExtensionList.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionStatus.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferErrorResponse.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferRequest.yaml

@@ -1,28 +0,0 @@
-type: object
-required:
-- bulkTransferId
-- homeTransactionId
-- bulkQuoteId
-- 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
-  bulkQuoteId:
-    $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/v2_1_0/components/schemas/bulkTransferResponse.yaml

@@ -1,29 +0,0 @@
-type: object
-required:
-- bulkTransferId
-- individualTransferResults
-- currentState
-properties:
-  bulkTransferId:
-    $ref: ./CorrelationId.yaml
-  bulkQuoteId:
-    $ref: ./CorrelationId.yaml
-  homeTransactionId:
-    type: string
-    description: >-
-      Transaction ID from the DFSP backend, used to reconcile transactions
-      between the Switch and DFSP backend systems.
-  bulkTransferState:
-    $ref: ./TransferState.yaml
-  completedTimestamp:
-    $ref: ./DateTime.yaml
-  extensionList:
-    $ref: ./ExtensionList.yaml
-  currentState:
-    $ref: ../schemas/bulkTransferStatus.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/v2_1_0/components/schemas/bulkTransferStatus.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/errorAccountsResponse.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/errorQuotesResponse.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/errorResponse.yaml

@@ -1,10 +0,0 @@
-type: object
-properties:
-  statusCode:
-    type: string
-    description: |
-      Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.
-      Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
-  message:
-    type: string
-    description: Error message text.

package/sdk-scheme-adapter/v2_1_0/components/schemas/errorSimpleTransfersResponse.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/errorTransferResponse.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/extensionListEmptiable.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/getPartiesResponse.yaml

@@ -1,11 +0,0 @@
-title: getPartiesResponse
-type: object
-description: 'The object sent in the GET /parties/{Type}/{ID} callback.'
-properties:
-  body:
-    $ref: ./Party.yaml
-  headers:
-    type: object
-required:
-  - body
-  - headers

package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuote.yaml

@@ -1,29 +0,0 @@
-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: ./transferTransactionType.yaml
-  subScenario:
-    $ref: ./TransactionSubScenario.yaml
-  note:
-    $ref: ./Note.yaml
-  extensions:
-    $ref: ./ExtensionList.yaml
-required:
-  - quoteId
-  - to
-  - amountType
-  - currency
-  - transactionType
-  - amount

package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuoteResult.yaml

@@ -1,25 +0,0 @@
-type: object
-properties:
-  quoteId:
-    $ref: ./CorrelationId.yaml
-  transferAmount:
-    $ref: ./Money.yaml
-  payeeReceiveAmount:
-    $ref: ./Money.yaml
-  payeeFspFee:
-    $ref: ./Money.yaml
-  payeeFspCommission:
-    $ref: ./Money.yaml
-  geoCode:
-    $ref: ./GeoCode.yaml
-  ilpPacket:
-    $ref: ./IlpPacket.yaml
-  condition:
-    $ref: ./IlpCondition.yaml
-  extensionList:
-    $ref: ./ExtensionList.yaml
-  lastError:
-    $ref: ./quoteError.yaml
-required:
-  - quoteId
-

package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransfer.yaml

@@ -1,34 +0,0 @@
-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: ./transferTransactionType.yaml
-  subScenario:
-    $ref: ./TransactionSubScenario.yaml
-  ilpPacket:
-    $ref: ./IlpPacket.yaml
-  condition:
-    $ref: ./IlpCondition.yaml
-  note:
-    $ref: ./Note.yaml
-  extensions:
-    $ref: ./ExtensionList.yaml
-required:
-  - transferId
-  - to
-  - amountType
-  - currency
-  - amount
-  - ilpPacket
-  - condition

package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferFulfilment.yaml

@@ -1,9 +0,0 @@
-type: object
-description: >-
-  A Mojaloop API transfer fulfilment for individual transfers in a bulk
-  transfer
-properties:
-  fulfilment:
-    $ref: ./IlpFulfilment.yaml
-  extensionList:
-    $ref: ./ExtensionList.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferResult.yaml

@@ -1,14 +0,0 @@
-type: object
-required:
-  - transferId
-properties:
-  transferId:
-    $ref: ./CorrelationId.yaml
-  fulfilment:
-    $ref: ./IlpFulfilment.yaml
-  extensionList:
-    $ref: ./ExtensionList.yaml
-  transferState:
-    $ref: ./TransferState.yaml
-  lastError:
-    $ref: ./transferError.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/mojaloopError.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/partiesByIdResponse.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/partyError.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/quoteError.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/quotesPostResponse.yaml

@@ -1,48 +0,0 @@
-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/v2_1_0/components/schemas/requestToPayRequest.yaml

@@ -1,32 +0,0 @@
-type: object
-required:
-  - homeR2PTransactionId
-  - from
-  - to
-  - amountType
-  - currency
-  - amount
-  - transactionType
-properties:
-  homeR2PTransactionId:
-    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
-  transactionType:
-    $ref: ./TransactionScenario.yaml
-  subScenario:
-    $ref: ./TransactionSubScenario.yaml
-  authenticationType:
-    $ref: './AuthenticationType.yaml'
-

package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayResponse.yaml

@@ -1,35 +0,0 @@
-type: object
-required:
-  - transactionRequestId
-  - from
-  - to
-  - amountType
-  - currency
-  - amount
-  - transactionType
-  - currentState
-properties:
-  transactionRequestId:
-    $ref: ./CorrelationId.yaml
-  from:
-    $ref: ./transferParty.yaml
-  to:
-    $ref: ./transferParty.yaml
-  amountType:
-    $ref: ./AmountType.yaml
-  currency:
-    $ref: ./Currency.yaml
-  amount:
-    $ref: ./Amount.yaml
-  transactionType:
-    $ref: ./TransactionScenario.yaml
-  subScenario:
-    $ref: ./TransactionSubScenario.yaml
-  currentState:
-    $ref: ./requestToPayStatus.yaml
-  getPartiesResponse:
-    $ref: ./getPartiesResponse.yaml
-  transactionRequestResponse:
-    $ref: ./TransactionRequestResponse.yaml
-  lastError:
-    $ref: ./transferError.yaml

package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayStatus.yaml

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayTransferRequest.yaml

@@ -1,42 +0,0 @@
-type: object
-required:
-  - homeR2PTransactionId
-  - transactionRequestId
-  - from
-  - to
-  - amountType
-  - currency
-  - amount
-  - scenario
-  - initiator
-  - initiatorType
-properties:
-  homeR2PTransactionId:
-    type: string
-    description: >-
-      Transaction ID from the DFSP backend, used to reconcile transactions
-      between the Switch and DFSP backend systems.
-  transactionRequestId:
-    $ref: ./CorrelationId.yaml
-  from:
-    $ref: ./transferParty.yaml
-  to:
-    $ref: ./transferParty.yaml
-  amountType:
-    $ref: ./AmountType.yaml
-  currency:
-    $ref: ./Currency.yaml
-  amount:
-    $ref: ./Amount.yaml
-  scenario:
-    $ref: ./TransactionScenario.yaml
-  subScenario:
-    $ref: ./TransactionSubScenario.yaml
-  initiator:
-    $ref: ./TransactionInitiator.yaml
-  initiatorType:
-    $ref: ./TransactionInitiatorType.yaml
-  note:
-    $ref: ./Note.yaml
-  authenticationType:
-    $ref: './AuthenticationType.yaml'