npm - @mojaloop/api-snippets - Versions diffs - 18.0.0-snapshot.4 → 18.0.0 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (356) hide show

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

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

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

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

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

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

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

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

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

@@ -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/schemas/AuthenticationInfo.yaml CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -1,16 +1,15 @@
 type: object
+additionalProperties: false
 required:
-  - accountIdType
-  - accountIdValue
+  - idType
+  - idValue
 properties:
-  accountIdType:
+  idType:
     $ref: ./PartyIdType.yaml
-  accountIdValue:
+  idValue:
     $ref: ./PartyIdentifier.yaml
-  accountSubIdOrType:
+  subIdOrType:
     $ref: ./PartySubIdOrType.yaml
-  modelId:
-    $ref: ./CorrelationId.yaml
   response:
     $ref: ./accountDeletionStatus.yaml
   currentState:

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

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

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

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

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

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

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

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

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

@@ -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 CHANGED Viewed

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

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

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

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

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

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

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

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

@@ -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 CHANGED Viewed

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

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

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

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

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

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

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

package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferResponse.yaml CHANGED Viewed

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 required:
 - bulkTransferId
 - individualTransferResults

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

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

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 properties:
   statusCode:
     type: string

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

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

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

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

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

@@ -1,5 +1,6 @@
 title: getPartiesResponse
 type: object
+additionalProperties: false
 description: 'The object sent in the GET /parties/{Type}/{ID} callback.'
 properties:
   body:

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

@@ -1,5 +1,6 @@
 title: IndividualQuote
 type: object
+additionalProperties: false
 description: Data model for the complex type 'individualQuote'.
 properties:
   quoteId:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 properties:
   quoteId:
     $ref: ./CorrelationId.yaml

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

@@ -1,5 +1,6 @@
 title: IndividualTransfer
 type: object
+additionalProperties: false
 description: Data model for the complex type 'individualTransfer'.
 properties:
   transferId:

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

@@ -1,4 +1,5 @@
 type: object
+additionalProperties: false
 description: >-
   A Mojaloop API transfer fulfilment for individual transfers in a bulk
   transfer

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

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