@mojaloop/api-snippets 18.0.0-snapshot.3 → 18.0.0

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - transactionRequestId
   - from

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - homeR2PTransactionId
   - transactionRequestId
@@ -39,4 +40,4 @@ properties:
   note:
     $ref: ./Note.yaml
   authenticationType:
-    $ref: './AuthenticationType.yaml'
+    $ref: './AuthenticationType.yaml'

package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayTransferResponse.yaml

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - transactionRequestId
   - from

package/sdk-scheme-adapter/v2_0_0/components/schemas/simpleQuotesPostRequest.yaml

@@ -1,5 +1,6 @@
 title: simpleQuotesPostRequest
 type: object
+additionalProperties: false
 properties:
   fspId:
     $ref: ./FspId.yaml

package/sdk-scheme-adapter/v2_0_0/components/schemas/simpleTransfersPostRequest.yaml

@@ -1,5 +1,6 @@
 title: SimpleTransfersPostRequest
 type: object
+additionalProperties: false
 properties:
   fspId:
     $ref: ./FspId.yaml

package/sdk-scheme-adapter/v2_0_0/components/schemas/simpleTransfersPostResponse.yaml

@@ -1,5 +1,6 @@
 title: SimpleTransfersPostResponse
 type: object
+additionalProperties: false
 properties:
   transfer:
     properties:

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferContinuationAcceptOTP.yaml

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - acceptOTP
 properties:

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferContinuationAcceptParty.yaml

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - acceptParty
 properties:

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferContinuationAcceptQuote.yaml

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - acceptQuote
 properties:

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferError.yaml

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 description: >-
   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

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferParty.yaml

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - idType
   - idValue

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferRequest.yaml

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - homeTransactionId
   - from

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferResponse.yaml

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - homeTransactionId
   - from

package/sdk-scheme-adapter/v2_0_0/components/schemas/transferStatusResponse.yaml

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - transferId
   - currentState

package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml

@@ -1459,7 +1459,7 @@ components:
           description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
           type: string
         transferState:
-          $ref: '#/components/schemas/transferState'
+          $ref: '../components/schemas/TransferStateFromBackend.yaml'
       required:
         - homeTransactionId
       type: object

package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionCompleted.yaml

@@ -2,4 +2,4 @@ description: Account deletion completed
 content:
   application/json:
     schema:
-      $ref: ../schemas/accountsResponse.yaml
+      $ref: ../schemas/accountDeletionResponse.yaml

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

@@ -1,5 +1,6 @@
 title: AuthenticationInfo
 type: object
+additionalProperties: false
 description: Data model for the complex type AuthenticationInfo.
 properties:
   authentication:

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

@@ -14,6 +14,7 @@ anyOf:
     description: QR code used as a One Time Password.
   - title: U2FPinValue
     type: object
+    additionalProperties: false
     description: >
       U2F challenge-response, where payer FSP verifies if the response
       provided by end-user device matches the previously registered key.

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

@@ -1,5 +1,6 @@
 title: AuthorizationIDPutResponse
 type: object
+additionalProperties: false
 description: The object sent in the PUT /authorizations/{ID} callback.
 properties:
   authenticationInfo:

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

@@ -1,5 +1,6 @@
 title: ErrorInformation
 type: object
+additionalProperties: false
 description: Data model for the complex type ErrorInformation.
 properties:
   errorCode:

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

@@ -1,5 +1,6 @@
 title: ExtensionList
 type: object
+additionalProperties: false
 description: >-
   Data model for the complex type ExtensionList. An optional list of extensions,
   specific to deployment.

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

@@ -1,5 +1,6 @@
 title: Extension_v2_1_0
 type: object
+additionalProperties: false
 description: Data model for the complex type Extension.
 properties:
   key:

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

@@ -1,5 +1,6 @@
 title: FxCharge
 type: object
+additionalProperties: false
 description: An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object.
 properties:
   chargeType:
@@ -16,4 +17,4 @@ properties:
       - $ref: ./Money.yaml
       - description: The amount of the charge which is being levied, expressed in the target currency.
 required:
-  - chargeType
+  - chargeType

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

@@ -1,5 +1,6 @@
 title: FxConversion
 type: object
+additionalProperties: false
 description: A DFSP will be able to request a currency conversion, and an FX provider will be able to describe its involvement in a proposed transfer, using a FxConversion object.
 properties:
   conversionId:
@@ -54,4 +55,4 @@ required:
   - amountType
   - sourceAmount
   - targetAmount
-  - expiration
+  - expiration

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

@@ -1,5 +1,6 @@
 title: FxMoney
 type: object
+additionalProperties: false
 description: Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations.
 properties:
   currency:

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

@@ -1,5 +1,6 @@
 title: FxQuotesPostBackendRequest
 type: object
+additionalProperties: false
 description: The object sent in the POST /fxQuotes request.
 properties:
   conversionRequestId:

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

@@ -1,5 +1,6 @@
 title: FxQuotesPostBackendResponse
 type: object
+additionalProperties: false
 description: The object sent as a response for the POST /fxQuotes request. The terms under which the FXP will undertake the currency conversion proposed by the requester.
 properties:
   homeTransactionId:

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

@@ -1,5 +1,6 @@
 title: FxQuotesPostOutboundRequest
 type: object
+additionalProperties: false
 description: The object sent in the POST /fxQuotes request.
 properties:
   homeTransactionId:

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

@@ -1,5 +1,6 @@
 title: FxQuotesPostOutboundResponse
 type: object
+additionalProperties: false
 description: The object sent as a response for the POST /fxQuotes request. The terms under which the FXP will undertake the currency conversion proposed by the requester.
 properties:
   homeTransactionId:

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

@@ -1,6 +1,7 @@
 title: fxTransfersPatchBackendRequest
 description: PATCH /fxTransfers/{commitRequestId} object.
 type: object
+additionalProperties: false
 properties:
   conversionId:
     type: string

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

@@ -1,5 +1,6 @@
 title: FxTransfersPostBackendRequest
 type: object
+additionalProperties: false
 description: The object sent in the POST /fxTransfers request.
 properties:
   homeTransactionId:

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

@@ -1,5 +1,6 @@
 title: FxTransfersPostBackendResponse
 type: object
+additionalProperties: false
 description: 'The object sent as a response for the POST /fxTransfers request.'
 properties:
   homeTransactionId:
@@ -10,7 +11,7 @@ properties:
   completedTimestamp:
     $ref: "../../../../fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPutResponse.yaml#/properties/completedTimestamp"
   conversionState:
-    $ref: "../../../../fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPutResponse.yaml#/properties/conversionState"
+    $ref: ./TransferStateFromBackend.yaml
   extensionList:
     $ref: "./ExtensionList_v2_1_0.yaml"
 required:

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

@@ -1,5 +1,6 @@
 title: FxTransfersPostOutboundRequest
 type: object
+additionalProperties: false
 description: The object sent in the POST /fxTransfers request.
 properties:
   homeTransactionId:

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

@@ -1,5 +1,6 @@
 title: FxTransfersPostOutboundResponse
 type: object
+additionalProperties: false
 description: 'The object sent as a response for the POST /fxTransfers request.'
 properties:
   homeTransactionId:

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

@@ -1,5 +1,6 @@
 title: FxTransfersPutBackendRequest
 type: object
+additionalProperties: false
 description: 'PUT /fxTransfers/{commitRequestId} object'
 properties:
   homeTransactionId:

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

@@ -1,5 +1,6 @@
 title: GeoCode
 type: object
+additionalProperties: false
 description: >-
   Data model for the complex type GeoCode. Indicates the geographic location
   from where the transaction was initiated.

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

@@ -1,5 +1,6 @@
 title: Money
 type: object
+additionalProperties: false
 description: Data model for the complex type Money.
 properties:
   currency:

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

@@ -1,5 +1,6 @@
 title: Party
 type: object
+additionalProperties: false
 description: Data model for the complex type Party.
 properties:
   partyIdInfo:

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

@@ -1,5 +1,6 @@
 title: PartyComplexName
 type: object
+additionalProperties: false
 description: Data model for the complex type PartyComplexName.
 properties:
   firstName:

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

@@ -1,5 +1,6 @@
 title: PartyIdInfo
 type: object
+additionalProperties: false
 description: >-
   Data model for the complex type PartyIdInfo. An ExtensionList element has been
   added to this reqeust in version v1.1

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

@@ -1,5 +1,6 @@
 title: PartyPersonalInfo
 type: object
+additionalProperties: false
 description: Data model for the complex type PartyPersonalInfo.
 properties:
   complexName:

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

@@ -1,5 +1,6 @@
 title: QuotesIDPutResponse
 type: object
+additionalProperties: false
 description: The object sent in the PUT /quotes/{ID} callback.
 properties:
   transferAmount:

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

@@ -1,5 +1,6 @@
 title: QuotesPostRequest
 type: object
+additionalProperties: false
 description: The object sent in the POST /quotes request.
 properties:
   quoteId:

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

@@ -1,5 +1,6 @@
 title: Refund
 type: object
+additionalProperties: false
 description: Data model for the complex type Refund.
 properties:
   originalTransactionId:

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

@@ -1,5 +1,6 @@
 title: TransactionRequestResponse
 type: object
+additionalProperties: false
 description: 'The object sent in the PUT /transactionRequests/{ID} callback.'
 properties:
   body:

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

@@ -1,5 +1,6 @@
 title: TransactionType
 type: object
+additionalProperties: false
 description: Data model for the complex type TransactionType.
 properties:
   scenario:

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

@@ -0,0 +1,15 @@
+title: TransferStateFromBackend
+type: string
+enum:
+  - RESERVED
+  - COMMITTED
+description: >-
+  Below are the allowed values for the enumeration.
+
+  - RESERVED - Next ledger has reserved the transfer.
+
+  - COMMITTED - Next ledger has successfully performed the transfer.
+
+  Note: There is no ABORTED state, http error response with proper mojaloop error code should be used to abort / reject a transfer.
+
+example: 'COMMITTED'

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

@@ -1,5 +1,6 @@
 title: TransfersIDPutResponse
 type: object
+additionalProperties: false
 description: The object sent in the PUT /transfers/{ID} callback.
 properties:
   fulfilment:

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

@@ -1,5 +1,6 @@
 title: TransfersPostRequest
 type: object
+additionalProperties: false
 description: The object sent in the POST /transfers request.
 properties:
   transferId:

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

@@ -1,6 +1,7 @@
 type: array
 items:
   type: object
+  additionalProperties: false
   required:
     - idType
     - idValue

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

@@ -1,18 +1,22 @@
 type: object
+additionalProperties: false
 required:
-  - accounts
+  - idType
+  - idValue
 properties:
-  modelId:
-    $ref: ./CorrelationId.yaml
-  fspId:
-    $ref: ./FspId.yaml
+  idType:
+    $ref: ./PartyIdType.yaml
+  idValue:
+    $ref: ./PartyIdentifier.yaml
+  subIdOrType:
+    $ref: ./PartySubIdOrType.yaml
   response:
     $ref: ./accountDeletionStatus.yaml
   currentState:
     $ref: ./accountDeletionState.yaml
   lastError:
     $ref: ./transferError.yaml
-  postAccountsResponse:
+  deleteAccountResponse:
     type: object
     required:
       - body

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

@@ -1,6 +1,7 @@
 type: array
 items:
   type: object
+  additionalProperties: false
   required:
     - fspId
   properties:

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

@@ -1,10 +1,10 @@
 type: array
 items:
   type: object
+  additionalProperties: false
   required:
     - idType
     - idValue
-    - currency
   properties:
     idType:
       $ref: ./PartyIdType.yaml

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - accounts
 properties:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - enabled
 properties:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - enabled
 properties:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - currency
   - amount

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

@@ -1,6 +1,7 @@
 allOf:
   - $ref: ./errorResponse.yaml
   - type: object
+    additionalProperties: false
     required:
       - bulkQuoteState
     properties:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - homeTransactionId
   - from

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - bulkQuoteId
   - individualQuoteResults

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - bulkQuoteId
   - currentState

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

@@ -1,6 +1,7 @@
 allOf:
   - $ref: ./errorResponse.yaml
   - type: object
+    additionalProperties: false
     required:
       - bulkTransferState
     properties:

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

@@ -1,6 +1,7 @@
 allOf:
   - $ref: ./errorResponse.yaml
   - type: object
+    additionalProperties: false
     required:
       - bulkTansferState
     properties:

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

@@ -2,6 +2,7 @@ description: >-
   The object sent back as confirmation of payee parties when autoAcceptParty is
   false.
 type: object
+additionalProperties: false
 required:
   - individualTransfers
 properties:

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

@@ -1,5 +1,6 @@
 description: The object sent back as confirmation of quotes when autoAcceptQuotes is false.
 type: object
+additionalProperties: false
 required:
   - individualTransfers
 properties:

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

@@ -1,5 +1,6 @@
 title: BulkTransactionIndividualTransfer
 type: object
+additionalProperties: false
 description: Data model for the complex type 'bulkTransactionIndividualTransfer'.
 properties:
   homeTransactionId:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 description: Data model for the 'individualTransfer' while accepting party or quote.
 properties:
   transferId:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - homeTransactionId
 properties:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - autoAcceptParty
   - autoAcceptQuote
@@ -28,7 +29,7 @@ properties:
   synchronous:
     description: >-
       Set to true if the bulkTransfer requests need be handled synchronous.
-      Otherwise the requests will be handled asynchronously, meaning there will 
+      Otherwise the requests will be handled asynchronously, meaning there will
       be callbacks whenever the processing is done
     type: boolean
   bulkExpiration:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
   - bulkTransactionId
   - bulkHomeTransactionID

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

@@ -1,5 +1,6 @@
 title: BulkTransactionResponse
 type: object
+additionalProperties: false
 required:
   - bulkHomeTransactionID
   - bulkTransactionId