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

package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml

@@ -1538,7 +1538,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'
       required:
         - homeTransactionId
       type: object
@@ -1610,6 +1610,7 @@ components:
       example: LOCALLY_DEFINED_SUBSCENARIO
     errorResponse:
       type: object
+      additionalProperties: false
       properties:
         statusCode:
           type: string
@@ -1634,6 +1635,7 @@ components:
         - COMPLETED
     autoAcceptPartyOption:
       type: object
+      additionalProperties: false
       required:
         - enabled
       properties:
@@ -1821,6 +1823,7 @@ components:
       example: '123.45'
     bulkPerTransferFeeLimit:
       type: object
+      additionalProperties: false
       required:
         - currency
         - amount
@@ -1831,6 +1834,7 @@ components:
           $ref: '#/components/schemas/Amount'
     autoAcceptQuote:
       type: object
+      additionalProperties: false
       required:
         - enabled
       properties:
@@ -1852,6 +1856,7 @@ components:
       example: '2016-05-24T08:38:08.699-04:00'
     bulkTransactionOptions:
       type: object
+      additionalProperties: false
       required:
         - autoAcceptParty
         - autoAcceptQuote
@@ -1871,7 +1876,7 @@ 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'
@@ -1924,6 +1929,7 @@ components:
     Extension_v2_1_0:
       title: Extension_v2_1_0
       type: object
+      additionalProperties: false
       description: Data model for the complex type Extension.
       properties:
         key:
@@ -1936,6 +1942,7 @@ components:
     ExtensionList_v2_1_0:
       title: ExtensionList
       type: object
+      additionalProperties: false
       description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
       properties:
         extension:
@@ -1950,6 +1957,7 @@ components:
     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:
@@ -1974,6 +1982,7 @@ components:
     PartyComplexName:
       title: PartyComplexName
       type: object
+      additionalProperties: false
       description: Data model for the complex type PartyComplexName.
       properties:
         firstName:
@@ -1985,6 +1994,7 @@ components:
     PartyPersonalInfo:
       title: PartyPersonalInfo
       type: object
+      additionalProperties: false
       description: Data model for the complex type PartyPersonalInfo.
       properties:
         complexName:
@@ -1996,6 +2006,7 @@ components:
     Party:
       title: Party
       type: object
+      additionalProperties: false
       description: Data model for the complex type Party.
       properties:
         partyIdInfo:
@@ -2036,6 +2047,7 @@ components:
     Money:
       title: Money
       type: object
+      additionalProperties: false
       description: Data model for the complex type Money.
       properties:
         currency:
@@ -2060,6 +2072,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:
@@ -2098,6 +2111,7 @@ components:
     ErrorInformation:
       title: ErrorInformation
       type: object
+      additionalProperties: false
       description: Data model for the complex type ErrorInformation.
       properties:
         errorCode:
@@ -2111,11 +2125,13 @@ components:
         - errorDescription
     mojaloopError:
       type: object
+      additionalProperties: false
       properties:
         errorInformation:
           $ref: '#/components/schemas/ErrorInformation'
     quoteError:
       type: object
+      additionalProperties: false
       description: This object represents a Mojaloop API error received at any time during the quote process
       properties:
         httpStatusCode:
@@ -2125,6 +2141,7 @@ components:
           $ref: '#/components/schemas/mojaloopError'
     individualQuoteResult:
       type: object
+      additionalProperties: false
       properties:
         quoteId:
           $ref: '#/components/schemas/CorrelationId'
@@ -2172,6 +2189,7 @@ components:
       example: RESERVED
     transferError:
       type: object
+      additionalProperties: false
       description: This object represents a Mojaloop API error received at any time during the transfer process
       properties:
         httpStatusCode:
@@ -2181,6 +2199,7 @@ components:
           $ref: '#/components/schemas/mojaloopError'
     individualTransferResult:
       type: object
+      additionalProperties: false
       required:
         - transferId
       properties:
@@ -2196,6 +2215,7 @@ components:
           $ref: '#/components/schemas/transferError'
     bulkTransactionIndividualTransferResult:
       type: object
+      additionalProperties: false
       required:
         - homeTransactionId
       properties:
@@ -2234,6 +2254,7 @@ components:
     bulkTransactionResponse:
       title: BulkTransactionResponse
       type: object
+      additionalProperties: false
       required:
         - bulkHomeTransactionID
         - bulkTransactionId
@@ -2267,6 +2288,7 @@ components:
     FxRate:
       title: FxRate
       type: object
+      additionalProperties: false
       description: The FxRate object contains information about a currency conversion in the transfer. It can be used by parties to the transfer to exchange information with each other about the exchange rate for the transfer, to ensure that the best rate can be agreed on.
       properties:
         sourceAmount:
@@ -2293,9 +2315,22 @@ components:
         - QRCODE - QR code used as One Time Password.
         - U2F - U2F is a new addition isolated to Thirdparty stream.
       example: OTP
+    TransferStateFromBackend:
+      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
     TransfersIDPutResponse:
       title: TransfersIDPutResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /transfers/{ID} callback.
       properties:
         fulfilment:
@@ -2311,6 +2346,7 @@ components:
     TransfersPostRequest:
       title: TransfersPostRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /transfers request.
       properties:
         transferId:
@@ -2340,6 +2376,7 @@ components:
     QuotesIDPutResponse:
       title: QuotesIDPutResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /quotes/{ID} callback.
       properties:
         transferAmount:
@@ -2418,6 +2455,7 @@ components:
     Refund:
       title: Refund
       type: object
+      additionalProperties: false
       description: Data model for the complex type Refund.
       properties:
         originalTransactionId:
@@ -2435,6 +2473,7 @@ components:
     TransactionType:
       title: TransactionType
       type: object
+      additionalProperties: false
       description: Data model for the complex type TransactionType.
       properties:
         scenario:
@@ -2456,6 +2495,7 @@ components:
     QuotesPostRequest:
       title: QuotesPostRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /quotes request.
       properties:
         quoteId:
@@ -2503,6 +2543,7 @@ components:
     FxMoney:
       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:
@@ -2514,6 +2555,7 @@ components:
     FxCharge:
       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:
@@ -2534,6 +2576,7 @@ components:
     FxConversion:
       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:
@@ -2590,6 +2633,7 @@ components:
     FxQuotesPostBackendRequest:
       title: FxQuotesPostBackendRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /fxQuotes request.
       properties:
         conversionRequestId:
@@ -2606,6 +2650,7 @@ components:
     FxQuotesPostBackendResponse:
       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:
@@ -2648,6 +2693,7 @@ components:
     FxTransfersPostBackendRequest:
       title: FxTransfersPostBackendRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /fxTransfers request.
       properties:
         homeTransactionId:
@@ -2681,13 +2727,10 @@ components:
       allOf:
         - $ref: '#/components/schemas/DateTime'
         - description: Time and date when the conversion was executed.
-    conversionState:
-      allOf:
-        - $ref: '#/components/schemas/TransferState'
-        - description: The current status of the conversion request.
     FxTransfersPostBackendResponse:
       title: FxTransfersPostBackendResponse
       type: object
+      additionalProperties: false
       description: The object sent as a response for the POST /fxTransfers request.
       properties:
         homeTransactionId:
@@ -2698,14 +2741,19 @@ components:
         completedTimestamp:
           $ref: '#/components/schemas/completedTimestamp'
         conversionState:
-          $ref: '#/components/schemas/conversionState'
+          $ref: '#/components/schemas/TransferStateFromBackend'
         extensionList:
           $ref: '#/components/schemas/ExtensionList_v2_1_0'
       required:
         - conversionState
+    conversionState:
+      allOf:
+        - $ref: '#/components/schemas/TransferState'
+        - description: The current status of the conversion request.
     FxTransfersPutBackendRequest:
       title: FxTransfersPutBackendRequest
       type: object
+      additionalProperties: false
       description: PUT /fxTransfers/{commitRequestId} object
       properties:
         homeTransactionId:
@@ -2725,6 +2773,7 @@ components:
       title: fxTransfersPatchBackendRequest
       description: PATCH /fxTransfers/{commitRequestId} object.
       type: object
+      additionalProperties: false
       properties:
         conversionId:
           type: string