@mojaloop/api-snippets 17.0.1 → 17.0.2-snapshot.1

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

@@ -73,40 +73,12 @@ paths:
       description: The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote  is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
       operationId: BackendBulkTransactionsPut
       parameters:
-        - $ref: '#/components/parameters/bulkTransactionId'
+        - $ref: '../components/parameters/bulkTransactionId.yaml'
       requestBody:
         content:
           application/json:
             schema:
-              properties:
-                bulkHomeTransactionID:
-                  description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
-                  type: string
-                individualTransferResults:
-                  description: List of individual transfers in a bulk transfer with accept party information.
-                  items:
-                    description: Data model for the 'individualTransfer' while accepting party or quote.
-                    properties:
-                      homeTransactionId:
-                        description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
-                        type: string
-                      transactionId:
-                        description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
-                        example: b51ec534-ee48-4575-b6a9-ead2955b8069
-                        pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
-                        title: CorrelationId
-                        type: string
-                    required:
-                      - homeTransactionId
-                    type: object
-                  minItems: 1
-                  type: array
-              required:
-                - bulkHomeTransactionID
-                - individualTransferResults
-              type: object
-        description: Bulk transaction request body.
-        required: true
+              $ref: '../components/schemas/bulkTransactionResponse.yaml'
       responses:
         '202':
           description: Bulk transaction information successfully amended.
@@ -384,20 +356,8 @@ paths:
       summary: Receive notification for a specific transfer.
       tags:
         - Transfers
-
 components:
   parameters:
-    bulkTransactionId:
-      description: Identifier of the bulk transaction to continue as returned in.
-      in: path
-      name: bulkTransactionId
-      required: true
-      schema:
-        description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
-        example: b51ec534-ee48-4575-b6a9-ead2955b8069
-        pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
-        title: CorrelationId
-        type: string
     idSubValue:
       description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
       in: path
@@ -455,46 +415,6 @@ components:
       pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
       title: DateofBirth (type Date)
       type: string
-    Extension:
-      description: Data model for the complex type Extension
-      properties:
-        key:
-          $ref: '#/components/schemas/ExtensionKey'
-          description: Extension key.
-        value:
-          $ref: '#/components/schemas/ExtensionValue'
-          description: Extension value.
-      required:
-        - key
-        - value
-      title: Extension
-      type: object
-    ExtensionKey:
-      description: Extension key.
-      maxLength: 32
-      minLength: 1
-      title: ExtensionKey
-      type: string
-    ExtensionList:
-      description: Data model for the complex type ExtensionList
-      properties:
-        extension:
-          description: Number of Extension elements
-          items:
-            $ref: '#/components/schemas/Extension'
-          maxItems: 16
-          minItems: 1
-          type: array
-      required:
-        - extension
-      title: ExtensionList
-      type: object
-    ExtensionValue:
-      description: Extension value.
-      maxLength: 128
-      minLength: 1
-      title: ExtensionValue
-      type: string
     FirstName:
       description: First name of the Party (Name Type).
       example: Henrik
@@ -533,6 +453,8 @@ components:
           type: string
         quoteId:
           $ref: '#/components/schemas/quoteId'
+        subScenario:
+          $ref: '#/components/schemas/transactionSubScenario'
         to:
           $ref: '#/components/schemas/transferParty'
         transactionId:
@@ -607,6 +529,8 @@ components:
           maxLength: 128
           minLength: 1
           type: string
+        subScenario:
+          $ref: '#/components/schemas/transactionSubScenario'
         to:
           $ref: '#/components/schemas/transferParty'
         transactionType:
@@ -651,147 +575,6 @@ components:
       pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
       title: MiddleName
       type: string
-    Party:
-      description: Data model for the complex type Party.
-      properties:
-        merchantClassificationCode:
-          $ref: '#/components/schemas/MerchantClassificationCode'
-        name:
-          $ref: '#/components/schemas/PartyName'
-        partyIdInfo:
-          $ref: '#/components/schemas/PartyIdInfo'
-        personalInfo:
-          $ref: '#/components/schemas/PartyPersonalInfo'
-      required:
-        - partyIdInfo
-      title: Party
-      type: object
-    PartyComplexName:
-      description: Data model for the complex type PartyComplexName.
-      properties:
-        displayName:
-          description: Display name of the sender if known
-          type: string
-        firstName:
-          $ref: '#/components/schemas/FirstName'
-        idSubValue:
-          description: The sub identifier string used to identify the sender
-          type: string
-        idType:
-          $ref: '#/components/schemas/idType'
-        idValue:
-          description: The identifier string used to identify the sender
-          type: string
-        lastName:
-          $ref: '#/components/schemas/LastName'
-        middleName:
-          $ref: '#/components/schemas/MiddleName'
-        type:
-          $ref: '#/components/schemas/payerType'
-      title: PartyComplexName
-      type: object
-    PartyIdInfo:
-      description: Data model for the complex type PartyIdInfo.
-      properties:
-        extensionList:
-          $ref: '#/components/schemas/ExtensionList'
-        fspId:
-          $ref: '#/components/schemas/FspId'
-        partyIdType:
-          $ref: '#/components/schemas/PartyIdType'
-        partyIdentifier:
-          $ref: '#/components/schemas/PartyIdentifier'
-        partySubIdOrType:
-          $ref: '#/components/schemas/PartySubIdOrType'
-      required:
-        - partyIdType
-        - partyIdentifier
-      title: PartyIdInfo
-      type: object
-    PartyIdType:
-      description: |
-        This is a variant based on FSPIOP `PartyIdType` specification.
-        Main difference being the CONSENT and THIRD_PARTY_LINK enums.
-
-        Below are the allowed values for the enumeration.
-        - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
-        Number, that is, the phone number) is used as reference to a participant.
-        The MSISDN identifier should be in international format according to the
-        [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
-        Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
-        international prefix.
-        - EMAIL - An email is used as reference to a
-        participant. The format of the email should be according to the informational
-        [RFC 3696](https://tools.ietf.org/html/rfc3696).
-        - PERSONAL_ID - A personal identifier is used as reference to a participant.
-        Examples of personal identification are passport number, birth certificate
-        number, and national registration number. The identifier number is added in
-        the PartyIdentifier element. The personal identifier type is added in the
-        PartySubIdOrType element.
-        - BUSINESS - A specific Business (for example, an organization or a company)
-        is used as reference to a participant. The BUSINESS identifier can be in any
-        format. To make a transaction connected to a specific username or bill number
-        in a Business, the PartySubIdOrType element should be used.
-        - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
-        specific business or organization is used as reference to a Party.
-        For referencing a specific device under a specific business or organization,
-        use the PartySubIdOrType element.
-        - ACCOUNT_ID - A bank account number or FSP account ID should be used as
-        reference to a participant. The ACCOUNT_ID identifier can be in any format,
-        as formats can greatly differ depending on country and FSP.
-        - IBAN - A bank account number or FSP account ID is used as reference to a
-        participant. The IBAN identifier can consist of up to 34 alphanumeric
-        characters and should be entered without whitespace.
-        - ALIAS An alias is used as reference to a participant. The alias should be
-        created in the FSP as an alternative reference to an account owner.
-        Another example of an alias is a username in the FSP system.
-        The ALIAS identifier can be in any format. It is also possible to use the
-        PartySubIdOrType element for identifying an account under an Alias defined
-        by the PartyIdentifier.
-        - CONSENT - TBD
-        - THIRD_PARTY_LINK - TBD
-      enum:
-        - MSISDN
-        - EMAIL
-        - PERSONAL_ID
-        - BUSINESS
-        - DEVICE
-        - ACCOUNT_ID
-        - IBAN
-        - ALIAS
-        - CONSENT
-        - THIRD_PARTY_LINK
-      example: PERSONAL_ID
-      title: PartyIdType
-      type: string
-    PartyIdentifier:
-      description: Identifier of the Party.
-      example: '16135551212'
-      maxLength: 128
-      minLength: 1
-      title: PartyIdentifier
-      type: string
-    PartyName:
-      description: Name of the Party. Could be a real name or a nickname.
-      maxLength: 128
-      minLength: 1
-      title: PartyName
-      type: string
-    PartyPersonalInfo:
-      description: Data model for the complex type PartyPersonalInfo.
-      properties:
-        complexName:
-          $ref: '#/components/schemas/PartyComplexName'
-        dateOfBirth:
-          $ref: '#/components/schemas/DateOfBirth'
-      title: PartyPersonalInfo
-      type: object
-    PartySubIdOrType:
-      description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
-      maxLength: 128
-      minLength: 1
-      title: PartySubIdOrType
-      type: string
     amountCurrency:
       description: Object containing Amount and Currency of the transfer.
       properties:
@@ -1176,7 +959,7 @@ components:
         initiatedTimestamp:
           $ref: '#/components/schemas/timestamp'
         lastError:
-          $ref: '#/components/schemas/transferError'
+          $ref: '../components/schemas/transferError.yaml'
         prepare:
           properties:
             body:
@@ -1250,13 +1033,6 @@ components:
       maxLength: 128
       minLength: 1
       type: string
-    ilpFulfilment:
-      description: Fulfilment that must be attached to the transfer by the Payee.
-      example: WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
-      maxLength: 48
-      pattern: ^[A-Za-z0-9-_]{43}$
-      title: ilpFulfilment
-      type: string
     ilpPacketData:
       description: Object containing transfer object.
       properties:
@@ -1264,10 +1040,10 @@ components:
           $ref: '#/components/schemas/amountCurrency'
           description: Amount and currency of the transaction
         payee:
-          $ref: '#/components/schemas/Party'
+          $ref: '../components/schemas/Party.yaml'
           description: Information about the Payee in the proposed financial transaction.
         payer:
-          $ref: '#/components/schemas/Party'
+          $ref: '../components/schemas/Party.yaml'
           description: Information about the Payer in the proposed financial transaction.
         quoteId:
           $ref: '#/components/schemas/quoteId'
@@ -1305,11 +1081,6 @@ components:
       description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
       pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
       type: string
-    mojaloopError:
-      properties:
-        errorInformation:
-          $ref: '#/components/schemas/errorInformation'
-      type: object
     money:
       pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
       type: string
@@ -1377,6 +1148,8 @@ components:
           type: string
         quoteId:
           $ref: '#/components/schemas/quoteId'
+        subScenario:
+          $ref: '#/components/schemas/transactionSubScenario'
         to:
           $ref: '#/components/schemas/transferParty'
           description: Information about the Payee in the proposed financial transaction.
@@ -1485,6 +1258,8 @@ components:
           $ref: '#/components/schemas/transactionRequestId'
         transactionType:
           $ref: '#/components/schemas/transactionType'
+        subScenario:
+          $ref: '#/components/schemas/transactionSubScenario'
       required:
         - transactionRequestId
         - to
@@ -1517,6 +1292,12 @@ components:
         - ACCEPTED
         - REJECTED
       type: string
+    transactionSubScenario:
+      description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
+      example: LOCALLY_DEFINED_SUBSCENARIO
+      pattern: ^[A-Z_]{1,32}$
+      title: transactionSubScenario
+      type: string
     transactionType:
       enum:
         - TRANSFER
@@ -1533,6 +1314,8 @@ components:
           description: Specifies the type of the transaction initiator.
         scenario:
           $ref: '#/components/schemas/scenario'
+        subScenario:
+          $ref: '#/components/schemas/transactionSubScenario'
       required:
         - scenario
         - initiator
@@ -1556,6 +1339,8 @@ components:
         note:
           maxLength: 128
           type: string
+        subScenario:
+          $ref: '#/components/schemas/transactionSubScenario'
         timestamp:
           $ref: '#/components/schemas/timestamp'
         to:
@@ -1575,16 +1360,6 @@ components:
         - transactionType
         - timestamp
       type: object
-    transferError:
-      description: This object represents a Mojaloop API error received at any time during the transfer process.
-      properties:
-        httpStatusCode:
-          description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
-          type: integer
-        mojaloopError:
-          $ref: '#/components/schemas/mojaloopError'
-          description: If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object.
-      type: object
     transferId:
       description: A Mojaloop API transfer identifier (UUID).
       pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
@@ -1650,6 +1425,8 @@ components:
           $ref: '#/components/schemas/quoteResponse'
         quoteRequestExtensions:
           $ref: '#/components/schemas/extensionList'
+        subScenario:
+          $ref: '#/components/schemas/transactionSubScenario'
         to:
           $ref: '#/components/schemas/transferParty'
         transactionType:
@@ -1674,7 +1451,7 @@ components:
           description: Completed timestamp from the DFSP backend, used for testing purposes to inject a given completed timestamp via a rule.
           example: '2020-05-19T08:38:08.699-04:00'
         fulfilment:
-          $ref: '#/components/schemas/ilpFulfilment'
+          $ref: '../components/schemas/IlpFulfilment.yaml'
           description: Fulfilment from the DFSP backend, used for testing purposes to inject an invalid fulfilment via a rule.
         homeTransactionId:
           description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.

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

@@ -14,6 +14,8 @@ properties:
     $ref: ./Amount.yaml
   transactionType:
     $ref: ./transferTransactionType.yaml
+  subScenario:
+    $ref: ./TransactionSubScenario.yaml
   note:
     $ref: ./Note.yaml
   extensions:

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

@@ -14,6 +14,8 @@ properties:
     $ref: ./Amount.yaml
   transactionType:
     $ref: ./transferTransactionType.yaml
+  subScenario:
+    $ref: ./TransactionSubScenario.yaml
   ilpPacket:
     $ref: ./IlpPacket.yaml
   condition:

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

@@ -25,6 +25,8 @@ properties:
     $ref: ./Amount.yaml
   transactionType:
     $ref: ./transferTransactionType.yaml
+  subScenario:
+    $ref: ./TransactionSubScenario.yaml
   note:
     $ref: ./Note.yaml
   quoteRequestExtensions:

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

@@ -27,6 +27,8 @@ properties:
     $ref: ./Amount.yaml
   transactionType:
     $ref: ./transferTransactionType.yaml
+  subScenario:
+    $ref: ./TransactionSubScenario.yaml
   note:
     $ref: ./Note.yaml
   currentState: