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

package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml

@@ -664,6 +664,7 @@ components:
       type: array
       items:
         type: object
+        additionalProperties: false
         required:
           - idType
           - idValue
@@ -685,6 +686,7 @@ components:
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     errorResponse:
       type: object
+      additionalProperties: false
       properties:
         statusCode:
           type: string
@@ -696,6 +698,7 @@ components:
       type: array
       items:
         type: object
+        additionalProperties: false
         required:
           - idType
           - idValue
@@ -740,6 +743,7 @@ components:
     Extension:
       title: Extension
       type: object
+      additionalProperties: false
       description: Data model for the complex type Extension.
       properties:
         key:
@@ -752,6 +756,7 @@ components:
     ExtensionList:
       title: ExtensionList
       type: object
+      additionalProperties: false
       description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
       properties:
         extension:
@@ -766,6 +771,7 @@ components:
     ErrorInformation:
       title: ErrorInformation
       type: object
+      additionalProperties: false
       description: Data model for the complex type ErrorInformation.
       properties:
         errorCode:
@@ -779,11 +785,13 @@ components:
         - errorDescription
     mojaloopError:
       type: object
+      additionalProperties: false
       properties:
         errorInformation:
           $ref: '#/components/schemas/ErrorInformation'
     transferError:
       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 may occur inside the scheme adapter.
       properties:
         httpStatusCode:
@@ -793,6 +801,7 @@ components:
           $ref: '#/components/schemas/mojaloopError'
     accountsResponse:
       type: object
+      additionalProperties: false
       required:
         - accounts
       properties:
@@ -819,6 +828,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - executionState
           properties:
@@ -898,6 +908,7 @@ components:
       maxItems: 16
     transferParty:
       type: object
+      additionalProperties: false
       required:
         - idType
         - idValue
@@ -965,6 +976,7 @@ components:
     individualQuote:
       title: IndividualQuote
       type: object
+      additionalProperties: false
       description: Data model for the complex type 'individualQuote'.
       properties:
         quoteId:
@@ -994,6 +1006,7 @@ components:
         - amount
     bulkQuoteRequest:
       type: object
+      additionalProperties: false
       required:
         - homeTransactionId
         - from
@@ -1029,6 +1042,7 @@ components:
     Money:
       title: Money
       type: object
+      additionalProperties: false
       description: Data model for the complex type Money.
       properties:
         currency:
@@ -1053,6 +1067,7 @@ components:
     GeoCode:
       title: GeoCode
       type: object
+      additionalProperties: false
       description: Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
       properties:
         latitude:
@@ -1078,6 +1093,7 @@ components:
       description: Condition that must be attached to the transfer by the Payer.
     quoteError:
       type: object
+      additionalProperties: false
       description: This object represents a Mojaloop API error received at any time during the quote process
       properties:
         httpStatusCode:
@@ -1087,6 +1103,7 @@ components:
           $ref: '#/components/schemas/mojaloopError'
     individualQuoteResult:
       type: object
+      additionalProperties: false
       properties:
         quoteId:
           $ref: '#/components/schemas/CorrelationId'
@@ -1112,6 +1129,7 @@ components:
         - quoteId
     bulkQuoteResponse:
       type: object
+      additionalProperties: false
       required:
         - bulkQuoteId
         - individualQuoteResults
@@ -1139,6 +1157,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - bulkQuoteState
           properties:
@@ -1151,6 +1170,7 @@ components:
         - COMPLETED
     bulkQuoteStatusResponse:
       type: object
+      additionalProperties: false
       required:
         - bulkQuoteId
         - currentState
@@ -1168,6 +1188,7 @@ components:
             $ref: '#/components/schemas/individualQuote'
     autoAcceptPartyOption:
       type: object
+      additionalProperties: false
       required:
         - enabled
       properties:
@@ -1178,6 +1199,7 @@ components:
             - true
     bulkPerTransferFeeLimit:
       type: object
+      additionalProperties: false
       required:
         - currency
         - amount
@@ -1188,6 +1210,7 @@ components:
           $ref: '#/components/schemas/Amount'
     autoAcceptQuote:
       type: object
+      additionalProperties: false
       required:
         - enabled
       properties:
@@ -1203,6 +1226,7 @@ components:
             $ref: '#/components/schemas/bulkPerTransferFeeLimit'
     bulkTransactionOptions:
       type: object
+      additionalProperties: false
       required:
         - autoAcceptParty
         - autoAcceptQuote
@@ -1222,13 +1246,14 @@ components:
           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
+          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: '#/components/schemas/DateTime'
     PartyIdInfo:
       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
       properties:
         partyIdType:
@@ -1253,6 +1278,7 @@ components:
     PartyComplexName:
       title: PartyComplexName
       type: object
+      additionalProperties: false
       description: Data model for the complex type PartyComplexName.
       properties:
         firstName:
@@ -1264,6 +1290,7 @@ components:
     PartyPersonalInfo:
       title: PartyPersonalInfo
       type: object
+      additionalProperties: false
       description: Data model for the complex type PartyPersonalInfo.
       properties:
         complexName:
@@ -1273,6 +1300,7 @@ components:
     Party:
       title: Party
       type: object
+      additionalProperties: false
       description: Data model for the complex type Party.
       properties:
         partyIdInfo:
@@ -1288,6 +1316,7 @@ components:
     bulkTransactionIndividualTransfer:
       title: BulkTransactionIndividualTransfer
       type: object
+      additionalProperties: false
       description: Data model for the complex type 'bulkTransactionIndividualTransfer'.
       properties:
         homeTransactionId:
@@ -1320,6 +1349,7 @@ components:
         - amount
     bulkTransactionRequest:
       type: object
+      additionalProperties: false
       required:
         - bulkTransactionId
         - bulkHomeTransactionID
@@ -1368,6 +1398,7 @@ components:
       example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
     individualTransferResult:
       type: object
+      additionalProperties: false
       required:
         - transferId
       properties:
@@ -1383,6 +1414,7 @@ components:
           $ref: '#/components/schemas/transferError'
     bulkTransferResponse:
       type: object
+      additionalProperties: false
       required:
         - bulkTransferId
         - individualTransferResults
@@ -1413,6 +1445,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - bulkTransferState
           properties:
@@ -1420,6 +1453,7 @@ components:
               $ref: '#/components/schemas/bulkTransferResponse'
     bulkTransactionIndividualTransferAccept:
       type: object
+      additionalProperties: false
       description: Data model for the 'individualTransfer' while accepting party or quote.
       properties:
         transferId:
@@ -1428,6 +1462,7 @@ components:
         - transferId
     transferContinuationAcceptParty:
       type: object
+      additionalProperties: false
       required:
         - acceptParty
       properties:
@@ -1439,6 +1474,7 @@ components:
     bulkTransactionContinuationAcceptParty:
       description: The object sent back as confirmation of payee parties when autoAcceptParty is false.
       type: object
+      additionalProperties: false
       required:
         - individualTransfers
       properties:
@@ -1452,6 +1488,7 @@ components:
               - $ref: '#/components/schemas/transferContinuationAcceptParty'
     transferContinuationAcceptQuote:
       type: object
+      additionalProperties: false
       required:
         - acceptQuote
       properties:
@@ -1463,6 +1500,7 @@ components:
     bulkTransactionContinuationAcceptQuote:
       description: The object sent back as confirmation of quotes when autoAcceptQuotes is false.
       type: object
+      additionalProperties: false
       required:
         - individualTransfers
       properties:
@@ -1476,6 +1514,7 @@ components:
               - $ref: '#/components/schemas/transferContinuationAcceptQuote'
     partyError:
       type: object
+      additionalProperties: false
       description: This object represents a Mojaloop API error received at any time during the party discovery process
       properties:
         httpStatusCode:
@@ -1487,6 +1526,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - bulkTransferState
           properties:
@@ -1498,6 +1538,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - bulkTansferState
           properties:
@@ -1508,6 +1549,7 @@ components:
     individualTransfer:
       title: IndividualTransfer
       type: object
+      additionalProperties: false
       description: Data model for the complex type 'individualTransfer'.
       properties:
         transferId:
@@ -1542,6 +1584,7 @@ components:
         - condition
     bulkTransferRequest:
       type: object
+      additionalProperties: false
       required:
         - bulkTransferId
         - homeTransactionId
@@ -1569,6 +1612,7 @@ components:
           $ref: '#/components/schemas/ExtensionList'
     individualTransferFulfilment:
       type: object
+      additionalProperties: false
       description: A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer
       properties:
         fulfilment:
@@ -1601,6 +1645,7 @@ components:
     partiesByIdResponse:
       title: partiesByIdResponse
       type: object
+      additionalProperties: false
       description: GET /parties/{Type}/{ID} response object
       properties:
         party:
@@ -1655,6 +1700,7 @@ components:
     Refund:
       title: Refund
       type: object
+      additionalProperties: false
       description: Data model for the complex type Refund.
       properties:
         originalTransactionId:
@@ -1672,6 +1718,7 @@ components:
     TransactionType:
       title: TransactionType
       type: object
+      additionalProperties: false
       description: Data model for the complex type TransactionType.
       properties:
         scenario:
@@ -1693,6 +1740,7 @@ components:
     QuotesPostRequest:
       title: QuotesPostRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /quotes request.
       properties:
         quoteId:
@@ -1732,6 +1780,7 @@ components:
     simpleQuotesPostRequest:
       title: simpleQuotesPostRequest
       type: object
+      additionalProperties: false
       properties:
         fspId:
           $ref: '#/components/schemas/FspId'
@@ -1743,6 +1792,7 @@ components:
     quotesPostResponse:
       title: QuotesPostResponse
       type: object
+      additionalProperties: false
       properties:
         quotes:
           title: QuotesIDPutResponse
@@ -1791,6 +1841,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+      additionalProperties: false
     AuthenticationType:
       title: AuthenticationType
       type: string
@@ -1806,6 +1857,7 @@ components:
       example: OTP
     requestToPayRequest:
       type: object
+      additionalProperties: false
       required:
         - homeR2PTransactionId
         - from
@@ -1843,6 +1895,7 @@ components:
     getPartiesResponse:
       title: getPartiesResponse
       type: object
+      additionalProperties: false
       description: The object sent in the GET /parties/{Type}/{ID} callback.
       properties:
         body:
@@ -1870,6 +1923,7 @@ components:
     TransactionRequestResponse:
       title: TransactionRequestResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /transactionRequests/{ID} callback.
       properties:
         body:
@@ -1890,6 +1944,7 @@ components:
         - headers
     requestToPayResponse:
       type: object
+      additionalProperties: false
       required:
         - transactionRequestId
         - from
@@ -1934,6 +1989,7 @@ components:
     QuotesIDPutResponse:
       title: QuotesIDPutResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /quotes/{ID} callback.
       properties:
         transferAmount:
@@ -1962,6 +2018,7 @@ components:
     TransfersIDPutResponse:
       title: TransfersIDPutResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /transfers/{ID} callback.
       properties:
         fulfilment:
@@ -1976,6 +2033,7 @@ components:
         - transferState
     transferResponse:
       type: object
+      additionalProperties: false
       required:
         - homeTransactionId
         - from
@@ -2050,6 +2108,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - transferState
           properties:
@@ -2057,6 +2116,7 @@ components:
               $ref: '#/components/schemas/transferResponse'
     requestToPayTransferRequest:
       type: object
+      additionalProperties: false
       required:
         - homeR2PTransactionId
         - transactionRequestId
@@ -2110,6 +2170,7 @@ components:
           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.
           properties:
@@ -2133,6 +2194,7 @@ components:
     AuthenticationInfo:
       title: AuthenticationInfo
       type: object
+      additionalProperties: false
       description: Data model for the complex type AuthenticationInfo.
       properties:
         authentication:
@@ -2158,6 +2220,7 @@ components:
     AuthorizationIDPutResponse:
       title: AuthorizationIDPutResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /authorizations/{ID} callback.
       properties:
         authenticationInfo:
@@ -2168,6 +2231,7 @@ components:
         - responseType
     requestToPayTransferResponse:
       type: object
+      additionalProperties: false
       required:
         - transactionRequestId
         - from
@@ -2237,6 +2301,7 @@ components:
           $ref: '#/components/schemas/transferError'
     transferContinuationAcceptOTP:
       type: object
+      additionalProperties: false
       required:
         - acceptOTP
       properties:
@@ -2248,6 +2313,7 @@ components:
     TransfersPostRequest:
       title: TransfersPostRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /transfers request.
       properties:
         transferId:
@@ -2277,6 +2343,7 @@ components:
     simpleTransfersPostRequest:
       title: SimpleTransfersPostRequest
       type: object
+      additionalProperties: false
       properties:
         fspId:
           $ref: '#/components/schemas/FspId'
@@ -2288,6 +2355,7 @@ components:
     simpleTransfersPostResponse:
       title: SimpleTransfersPostResponse
       type: object
+      additionalProperties: false
       properties:
         transfer:
           properties:
@@ -2307,8 +2375,10 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+      additionalProperties: false
     transferRequest:
       type: object
+      additionalProperties: false
       required:
         - homeTransactionId
         - from
@@ -2346,6 +2416,7 @@ components:
           type: boolean
     transferStatusResponse:
       type: object
+      additionalProperties: false
       required:
         - transferId
         - currentState