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

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

@@ -51,7 +51,7 @@ paths:
   /accounts/{Type}/{ID}:
     delete:
       summary: Delete account on the Account Lookup Service
-      description: The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
+      description: The HTTP request `DELETE /accounts/{Type}/{ID}` is used to account account information on the Account Lookup Service (ALS) by Type and ID.
       tags:
         - Accounts
       parameters:
@@ -69,7 +69,7 @@ paths:
   /accounts/{Type}/{ID}/{SubId}:
     delete:
       summary: Delete account on the Account Lookup Service
-      description: The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
+      description: The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on the Account Lookup Service (ALS) by Type, ID, and SubId.
       tags:
         - Accounts
       parameters:
@@ -784,10 +784,10 @@ components:
       type: array
       items:
         type: object
+        additionalProperties: false
         required:
           - idType
           - idValue
-          - currency
         properties:
           idType:
             $ref: '#/components/schemas/PartyIdType'
@@ -805,6 +805,7 @@ components:
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     errorResponse:
       type: object
+      additionalProperties: false
       properties:
         statusCode:
           type: string
@@ -818,6 +819,7 @@ components:
       type: array
       items:
         type: object
+        additionalProperties: false
         required:
           - idType
           - idValue
@@ -861,6 +863,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:
@@ -873,6 +876,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:
@@ -887,6 +891,7 @@ components:
     ErrorInformation:
       title: ErrorInformation
       type: object
+      additionalProperties: false
       description: Data model for the complex type ErrorInformation.
       properties:
         errorCode:
@@ -900,11 +905,13 @@ components:
         - errorDescription
     mojaloopError:
       type: object
+      additionalProperties: false
       properties:
         errorInformation:
           $ref: '#/components/schemas/ErrorInformation'
     transferError:
       type: object
+      additionalProperties: false
       description: This object represents a Mojaloop API error received at any time during the transfer process
       properties:
         httpStatusCode:
@@ -914,6 +921,7 @@ components:
           $ref: '#/components/schemas/mojaloopError'
     accountsResponse:
       type: object
+      additionalProperties: false
       required:
         - accounts
       properties:
@@ -945,6 +953,57 @@ components:
           properties:
             executionState:
               $ref: '#/components/schemas/accountsResponse'
+    FspId:
+      title: FspId
+      type: string
+      minLength: 1
+      maxLength: 32
+      description: FSP identifier.
+    accountDeletionStatus:
+      type: array
+      items:
+        type: object
+        additionalProperties: false
+        required:
+          - fspId
+        properties:
+          fspId:
+            $ref: '#/components/schemas/FspId'
+          error:
+            $ref: '#/components/schemas/errorResponse'
+    accountDeletionState:
+      type: string
+      enum:
+        - ERROR_OCCURRED
+        - COMPLETED
+    accountDeletionResponse:
+      type: object
+      additionalProperties: false
+      required:
+        - idType
+        - idValue
+      properties:
+        idType:
+          $ref: '#/components/schemas/PartyIdType'
+        idValue:
+          $ref: '#/components/schemas/PartyIdentifier'
+        subIdOrType:
+          $ref: '#/components/schemas/PartySubIdOrType'
+        response:
+          $ref: '#/components/schemas/accountDeletionStatus'
+        currentState:
+          $ref: '#/components/schemas/accountDeletionState'
+        lastError:
+          $ref: '#/components/schemas/transferError'
+        deleteAccountResponse:
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              type: object
+            headers:
+              type: object
     TransactionInitiatorType:
       title: TransactionInitiatorType
       type: string
@@ -1005,12 +1064,6 @@ components:
       type: string
       pattern: ^[\d]{1,4}$
       description: A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.
-    FspId:
-      title: FspId
-      type: string
-      minLength: 1
-      maxLength: 32
-      description: FSP identifier.
     KYCInformation:
       title: KYCInformation
       type: string
@@ -1053,6 +1106,7 @@ components:
       maxItems: 16
     transferParty:
       type: object
+      additionalProperties: false
       required:
         - idType
         - idValue
@@ -1129,6 +1183,7 @@ components:
     individualQuote:
       title: IndividualQuote
       type: object
+      additionalProperties: false
       description: Data model for the complex type 'individualQuote'.
       properties:
         quoteId:
@@ -1158,6 +1213,7 @@ components:
         - amount
     bulkQuoteRequest:
       type: object
+      additionalProperties: false
       required:
         - homeTransactionId
         - from
@@ -1193,6 +1249,7 @@ components:
     Money:
       title: Money
       type: object
+      additionalProperties: false
       description: Data model for the complex type Money.
       properties:
         currency:
@@ -1217,6 +1274,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:
@@ -1242,6 +1300,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:
@@ -1251,6 +1310,7 @@ components:
           $ref: '#/components/schemas/mojaloopError'
     individualQuoteResult:
       type: object
+      additionalProperties: false
       properties:
         quoteId:
           $ref: '#/components/schemas/CorrelationId'
@@ -1276,6 +1336,7 @@ components:
         - quoteId
     bulkQuoteResponse:
       type: object
+      additionalProperties: false
       required:
         - bulkQuoteId
         - individualQuoteResults
@@ -1303,6 +1364,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - bulkQuoteState
           properties:
@@ -1315,6 +1377,7 @@ components:
         - COMPLETED
     bulkQuoteStatusResponse:
       type: object
+      additionalProperties: false
       required:
         - bulkQuoteId
         - currentState
@@ -1332,6 +1395,7 @@ components:
             $ref: '#/components/schemas/individualQuote'
     autoAcceptPartyOption:
       type: object
+      additionalProperties: false
       required:
         - enabled
       properties:
@@ -1342,6 +1406,7 @@ components:
             - true
     bulkPerTransferFeeLimit:
       type: object
+      additionalProperties: false
       required:
         - currency
         - amount
@@ -1352,6 +1417,7 @@ components:
           $ref: '#/components/schemas/Amount'
     autoAcceptQuote:
       type: object
+      additionalProperties: false
       required:
         - enabled
       properties:
@@ -1367,6 +1433,7 @@ components:
             $ref: '#/components/schemas/bulkPerTransferFeeLimit'
     bulkTransactionOptions:
       type: object
+      additionalProperties: false
       required:
         - autoAcceptParty
         - autoAcceptQuote
@@ -1386,13 +1453,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:
@@ -1417,6 +1485,7 @@ components:
     PartyComplexName:
       title: PartyComplexName
       type: object
+      additionalProperties: false
       description: Data model for the complex type PartyComplexName.
       properties:
         firstName:
@@ -1428,6 +1497,7 @@ components:
     PartyPersonalInfo:
       title: PartyPersonalInfo
       type: object
+      additionalProperties: false
       description: Data model for the complex type PartyPersonalInfo.
       properties:
         complexName:
@@ -1439,6 +1509,7 @@ components:
     Party:
       title: Party
       type: object
+      additionalProperties: false
       description: Data model for the complex type Party.
       properties:
         partyIdInfo:
@@ -1461,6 +1532,7 @@ components:
     bulkTransactionIndividualTransfer:
       title: BulkTransactionIndividualTransfer
       type: object
+      additionalProperties: false
       description: Data model for the complex type 'bulkTransactionIndividualTransfer'.
       properties:
         homeTransactionId:
@@ -1493,6 +1565,7 @@ components:
         - amount
     bulkTransactionRequest:
       type: object
+      additionalProperties: false
       required:
         - bulkTransactionId
         - bulkHomeTransactionID
@@ -1541,6 +1614,7 @@ components:
       example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
     individualTransferResult:
       type: object
+      additionalProperties: false
       required:
         - transferId
       properties:
@@ -1556,6 +1630,7 @@ components:
           $ref: '#/components/schemas/transferError'
     bulkTransferResponse:
       type: object
+      additionalProperties: false
       required:
         - bulkTransferId
         - individualTransferResults
@@ -1586,6 +1661,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - bulkTransferState
           properties:
@@ -1593,6 +1669,7 @@ components:
               $ref: '#/components/schemas/bulkTransferResponse'
     bulkTransactionIndividualTransferAccept:
       type: object
+      additionalProperties: false
       description: Data model for the 'individualTransfer' while accepting party or quote.
       properties:
         transferId:
@@ -1601,6 +1678,7 @@ components:
         - transferId
     transferContinuationAcceptParty:
       type: object
+      additionalProperties: false
       required:
         - acceptParty
       properties:
@@ -1612,6 +1690,7 @@ components:
     bulkTransactionContinuationAcceptParty:
       description: The object sent back as confirmation of payee parties when autoAcceptParty is false.
       type: object
+      additionalProperties: false
       required:
         - individualTransfers
       properties:
@@ -1625,6 +1704,7 @@ components:
               - $ref: '#/components/schemas/transferContinuationAcceptParty'
     transferContinuationAcceptQuote:
       type: object
+      additionalProperties: false
       required:
         - acceptQuote
       properties:
@@ -1636,6 +1716,7 @@ components:
     bulkTransactionContinuationAcceptQuote:
       description: The object sent back as confirmation of quotes when autoAcceptQuotes is false.
       type: object
+      additionalProperties: false
       required:
         - individualTransfers
       properties:
@@ -1649,6 +1730,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:
@@ -1660,6 +1742,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - bulkTransferState
           properties:
@@ -1671,6 +1754,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - bulkTansferState
           properties:
@@ -1681,6 +1765,7 @@ components:
     individualTransfer:
       title: IndividualTransfer
       type: object
+      additionalProperties: false
       description: Data model for the complex type 'individualTransfer'.
       properties:
         transferId:
@@ -1715,6 +1800,7 @@ components:
         - condition
     bulkTransferRequest:
       type: object
+      additionalProperties: false
       required:
         - bulkTransferId
         - homeTransactionId
@@ -1742,6 +1828,7 @@ components:
           $ref: '#/components/schemas/ExtensionList_v2_1_0'
     individualTransferFulfilment:
       type: object
+      additionalProperties: false
       description: A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer
       properties:
         fulfilment:
@@ -1774,6 +1861,7 @@ components:
     partiesByIdResponse:
       title: partiesByIdResponse
       type: object
+      additionalProperties: false
       description: GET /parties/{Type}/{ID} response object
       properties:
         party:
@@ -1828,6 +1916,7 @@ components:
     Refund:
       title: Refund
       type: object
+      additionalProperties: false
       description: Data model for the complex type Refund.
       properties:
         originalTransactionId:
@@ -1845,6 +1934,7 @@ components:
     TransactionType:
       title: TransactionType
       type: object
+      additionalProperties: false
       description: Data model for the complex type TransactionType.
       properties:
         scenario:
@@ -1873,6 +1963,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:
@@ -1889,6 +1980,7 @@ components:
     QuotesPostRequest:
       title: QuotesPostRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /quotes request.
       properties:
         quoteId:
@@ -1936,6 +2028,7 @@ components:
     simpleQuotesPostRequest:
       title: simpleQuotesPostRequest
       type: object
+      additionalProperties: false
       properties:
         fspId:
           $ref: '#/components/schemas/FspId'
@@ -1947,6 +2040,7 @@ components:
     quotesPostResponse:
       title: QuotesPostResponse
       type: object
+      additionalProperties: false
       properties:
         quotes:
           title: QuotesIDPutResponse
@@ -1995,6 +2089,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+      additionalProperties: false
     AuthenticationType:
       title: AuthenticationType
       type: string
@@ -2010,6 +2105,7 @@ components:
       example: OTP
     requestToPayRequest:
       type: object
+      additionalProperties: false
       required:
         - homeR2PTransactionId
         - from
@@ -2047,6 +2143,7 @@ components:
     getPartiesResponse:
       title: getPartiesResponse
       type: object
+      additionalProperties: false
       description: The object sent in the GET /parties/{Type}/{ID} callback.
       properties:
         body:
@@ -2074,6 +2171,7 @@ components:
     TransactionRequestResponse:
       title: TransactionRequestResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /transactionRequests/{ID} callback.
       properties:
         body:
@@ -2094,6 +2192,7 @@ components:
         - headers
     requestToPayResponse:
       type: object
+      additionalProperties: false
       required:
         - transactionRequestId
         - from
@@ -2139,6 +2238,7 @@ components:
     QuotesIDPutResponse:
       title: QuotesIDPutResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /quotes/{ID} callback.
       properties:
         transferAmount:
@@ -2167,6 +2267,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:
@@ -2178,6 +2279,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:
@@ -2198,6 +2300,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:
@@ -2254,6 +2357,7 @@ components:
     FxQuotesPostOutboundResponse:
       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:
@@ -2272,6 +2376,7 @@ components:
     TransfersIDPutResponse:
       title: TransfersIDPutResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /transfers/{ID} callback.
       properties:
         fulfilment:
@@ -2286,6 +2391,7 @@ components:
         - transferState
     transferResponse:
       type: object
+      additionalProperties: false
       required:
         - homeTransactionId
         - from
@@ -2387,6 +2493,7 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+          additionalProperties: false
           required:
             - transferState
           properties:
@@ -2394,6 +2501,7 @@ components:
               $ref: '#/components/schemas/transferResponse'
     requestToPayTransferRequest:
       type: object
+      additionalProperties: false
       required:
         - homeR2PTransactionId
         - transactionRequestId
@@ -2447,6 +2555,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:
@@ -2470,6 +2579,7 @@ components:
     AuthenticationInfo:
       title: AuthenticationInfo
       type: object
+      additionalProperties: false
       description: Data model for the complex type AuthenticationInfo.
       properties:
         authentication:
@@ -2495,6 +2605,7 @@ components:
     AuthorizationIDPutResponse:
       title: AuthorizationIDPutResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /authorizations/{ID} callback.
       properties:
         authenticationInfo:
@@ -2505,6 +2616,7 @@ components:
         - responseType
     requestToPayTransferResponse:
       type: object
+      additionalProperties: false
       required:
         - transactionRequestId
         - from
@@ -2574,6 +2686,7 @@ components:
           $ref: '#/components/schemas/transferError'
     transferContinuationAcceptOTP:
       type: object
+      additionalProperties: false
       required:
         - acceptOTP
       properties:
@@ -2585,6 +2698,7 @@ components:
     TransfersPostRequest:
       title: TransfersPostRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /transfers request.
       properties:
         transferId:
@@ -2614,6 +2728,7 @@ components:
     simpleTransfersPostRequest:
       title: SimpleTransfersPostRequest
       type: object
+      additionalProperties: false
       properties:
         fspId:
           $ref: '#/components/schemas/FspId'
@@ -2625,6 +2740,7 @@ components:
     simpleTransfersPostResponse:
       title: SimpleTransfersPostResponse
       type: object
+      additionalProperties: false
       properties:
         transfer:
           properties:
@@ -2644,8 +2760,10 @@ components:
       allOf:
         - $ref: '#/components/schemas/errorResponse'
         - type: object
+      additionalProperties: false
     transferRequest:
       type: object
+      additionalProperties: false
       required:
         - homeTransactionId
         - from
@@ -2683,6 +2801,7 @@ components:
           type: boolean
     transferStatusResponse:
       type: object
+      additionalProperties: false
       required:
         - transferId
         - currentState
@@ -2703,6 +2822,7 @@ components:
               type: object
     transferContinuationAcceptConversion:
       type: object
+      additionalProperties: false
       required:
         - acceptConversion
       properties:
@@ -2713,6 +2833,7 @@ components:
             - false
     transferContinuationAcceptQuoteOrConversion:
       type: object
+      additionalProperties: false
       required:
         - acceptQuoteOrConversion
       properties:
@@ -2724,6 +2845,7 @@ components:
     ServicesFXPPutResponse:
       title: ServicesFXPPutResponse
       type: object
+      additionalProperties: false
       description: The object sent in the PUT /services/FXP callback.
       properties:
         providers:
@@ -2738,6 +2860,7 @@ components:
     FxQuotesPostOutboundRequest:
       title: FxQuotesPostOutboundRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /fxQuotes request.
       properties:
         homeTransactionId:
@@ -2785,6 +2908,7 @@ components:
     FxTransfersPostOutboundRequest:
       title: FxTransfersPostOutboundRequest
       type: object
+      additionalProperties: false
       description: The object sent in the POST /fxTransfers request.
       properties:
         homeTransactionId:
@@ -2825,6 +2949,7 @@ components:
     FxTransfersPostOutboundResponse:
       title: FxTransfersPostOutboundResponse
       type: object
+      additionalProperties: false
       description: The object sent as a response for the POST /fxTransfers request.
       properties:
         homeTransactionId:
@@ -2876,7 +3001,7 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/accountsResponse'
+            $ref: '#/components/schemas/accountDeletionResponse'
     accountDeletionError:
       description: An error occurred while deleting an account
       content: