@mojaloop/api-snippets 17.6.0 → 17.7.0-snapshot.1

package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml

@@ -2918,14 +2918,12 @@ components:
       title: CorrelationId
       type: string
       pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       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 (‘-‘).
+        Identifier that correlates all messages of the same sequence. The
+        supported identifiers formats are for lowercase
+        [UUID](https://datatracker.ietf.org/doc/html/rfc9562) and uppercase
+        [ULID](https://github.com/ulid/spec)
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     Currency:
       title: Currency

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

@@ -673,8 +673,8 @@ components:
         - RECEIVE
       type: string
     bulkQuoteId:
-      description: A Mojaloop API bulk quote 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}$
+      description: A Mojaloop API bulk quote identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     bulkQuoteRequest:
       description: A request for a bulk quote.
@@ -719,8 +719,8 @@ components:
         - individualQuoteResults
       type: object
     bulkTransferId:
-      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}$
+      description: A Mojaloop API transfer identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     bulkTransferRequest:
       properties:
@@ -1162,8 +1162,8 @@ components:
         - DEVICE
       type: string
     quoteId:
-      description: A Mojaloop API quote 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}$
+      description: A Mojaloop API quote identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     quoteRequest:
       description: A request for a quote for transfer from the DFSP backend.
@@ -1275,7 +1275,7 @@ components:
       type: string
     transactionId:
       description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     transactionRequest:
       description: A request for a pull based transfer.
@@ -1320,8 +1320,8 @@ components:
         - initiatorType
       type: object
     transactionRequestId:
-      description: A Mojaloop API transaction request 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}$
+      description: A Mojaloop API transaction request identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     transactionRequestResponse:
       description: A response to a request for a quote.
@@ -1412,8 +1412,8 @@ components:
         - timestamp
       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}$
+      description: A Mojaloop API transfer identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     transferParty:
       properties:
@@ -1603,8 +1603,8 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
-      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 (‘-‘).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
+      description: Identifier that correlates all messages of the same sequence. The supported identifiers formats are for lowercase [UUID](https://datatracker.ietf.org/doc/html/rfc9562) and uppercase [ULID](https://github.com/ulid/spec)
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     bulkTransactionStatus:
       type: string

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

@@ -762,8 +762,8 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
-      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 (‘-‘).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
+      description: Identifier that correlates all messages of the same sequence. The supported identifiers formats are for lowercase [UUID](https://datatracker.ietf.org/doc/html/rfc9562) and uppercase [ULID](https://github.com/ulid/spec)
       example: b51ec534-ee48-4575-b6a9-ead2955b8069
     errorResponse:
       type: object

package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml

@@ -1,10 +1,9 @@
 title: CorrelationId
 type: string
-pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
+pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
 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 (‘-‘).
+  Identifier that correlates all messages of the same sequence.
+  The supported identifiers formats are for
+  lowercase [UUID](https://datatracker.ietf.org/doc/html/rfc9562) and
+  uppercase [ULID](https://github.com/ulid/spec)
 example: 'b51ec534-ee48-4575-b6a9-ead2955b8069'

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml

@@ -5,8 +5,20 @@ description: >
   servicer.
 properties:
   IBAN:
+    description: >
+      IBAN
+
+      International Bank Account Number (IBAN) - identifier used internationally by financial
+      institutions to uniquely identify the account of a customer. Further specifications of the format and
+      content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services -
+      International Bank Account Number (IBAN)" version 1997-10-01, or later revisions.
     $ref: ./IBAN2007Identifier.yaml
   Othr:
+    description: >
+      Other
+
+      Unique identification of an account, as assigned by the account servicer, using an
+      identification scheme.
     $ref: ./GenericAccountIdentification1.yaml
 oneOf:
   - required:

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml

@@ -4,8 +4,16 @@ description: |
   Sets of elements to identify a name of the identification scheme.
 properties:
   Cd:
+    description: >
+      Code
+
+      Name of the identification scheme, in a coded form as published in an external list.
     $ref: ./ExternalAccountIdentification1Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Name of the identification scheme, in a free text form.
     $ref: ./Max35Text.yaml
 oneOf:
   - required:

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml

@@ -7,6 +7,10 @@ properties:
   ActiveCurrencyAndAmount:
     $ref: ./ActiveCurrencyAndAmount_SimpleType.yaml
   Ccy:
+    description: >
+      Currency
+
+      Identification of the currency in which the account is held.
     $ref: ./ActiveCurrencyCode.yaml
 required:
   - ActiveCurrencyAndAmount

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml

@@ -7,6 +7,10 @@ properties:
   ActiveOrHistoricCurrencyAndAmount:
     $ref: ./ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml
   Ccy:
+    description: >
+      Currency
+
+      Identification of the currency in which the account is held.
     $ref: ./ActiveOrHistoricCurrencyCode.yaml
 required:
   - ActiveOrHistoricCurrencyAndAmount

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml

@@ -1,5 +1,6 @@
 description: |
   AddressType2Code
+
   Specifies the type of address.
 enum:
   - ADDR

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml

@@ -4,8 +4,16 @@ description: |
   Choice of formats for the type of address.
 properties:
   Cd:
+    description: >
+      Code
+
+      Type of address expressed as a code.
     $ref: ./AddressType2Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Type of address expressed as a proprietary code.
     $ref: ./GenericIdentification30.yaml
 oneOf:
   - required:

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml

@@ -5,8 +5,20 @@ description: >
   of a financial institution.
 properties:
   FinInstnId:
+    description: >
+      FinancialInstitutionIdentification
+
+      Unique and unambiguous identification of a financial institution, as assigned under an
+      internationally recognised or proprietary identification scheme.
     $ref: ./FinancialInstitutionIdentification18.yaml
   BrnchId:
+    description: >
+      BranchIdentification
+
+      Definition: Identifies a specific branch of a financial institution.
+
+      Usage: This component should be used in case the identification information in the financial institution
+      component does not provide identification up to branch level.
     $ref: ./BranchData3.yaml
 required:
   - FinInstnId

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml

@@ -5,20 +5,34 @@ description: >
   of a financial institution.
 properties:
   FinInstnId:
+    description: >
+      FinancialInstitutionIdentification
+
+      Unique and unambiguous identification of a financial institution or a branch of a financial
+      institution.
     $ref: ./FinancialInstitutionIdentification23.yaml
   BrnchId:
+    description: >
+      BranchIdentification
+
+       Identifies a specific branch of a financial institution.
     $ref: ./BranchData5.yaml
 required:
   - FinInstnId
 example:
   FinInstnId:
-    BICFI: BUKBGB22
+    BICFI: J5BMVH7D
   BrnchId:
-    Id: 12345
-    Nm: Oxford Street Branch
+    Id: 123
+    Nm: Name
     PstlAdr:
-      Ctry: GB
-      AdrLine:
-        - 1 Oxford Street
-        - London
-        - UK
+      AdrTp: ADDR
+      Dept: Department
+      SubDept: Sub department
+      StrtNm: Street name
+      BldgNb: Building number
+      PstCd: Post code
+      TwnNm: Town name
+      CtrySubDvsn: Country subdivision
+      Ctry: Country
+      AdrLine: Address line

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml

@@ -5,12 +5,28 @@ description: >
   institution.
 properties:
   Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification of a branch of a financial institution.
     $ref: ./Max35Text.yaml
   LEI:
+    description: >
+      Legal Entity Identifier
+
+      Legal entity identification for the branch of the financial institution.
     $ref: ./LEIIdentifier.yaml
   Nm:
+    description: >
+      Name
+
+      Name by which an agent is known and which is usually used to identify that agent.
     $ref: ./Max140Text.yaml
   PstlAdr:
+    description: >
+      Postal Address
+
+      Information that locates and identifies a specific address, as defined by postal services.
     $ref: ./PostalAddress24.yaml
 example:
   Id: 123

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml

@@ -5,19 +5,41 @@ description: >
 type: object
 properties:
   Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification of a branch of a financial institution.
     $ref: ./Max35Text.yaml
   LEI:
+    description: >
+      LEI
+
+      Legal entity identification for the branch of the financial institution.
     $ref: ./LEIIdentifier.yaml
   Nm:
+    description: >
+      Name
+
+      Name by which an agent is known and which is usually used to identify that agent.
     $ref: ./Max140Text.yaml
   PstlAdr:
+    description: >
+      PostalAddress
+
+      Information that locates and identifies a specific address, as defined by postal services.
     $ref: ./PostalAddress27.yaml
 example:
   Id: 123
-  Nm: Oxford Street Branch
+  LEI: 123
+  Nm: Name
   PstlAdr:
-    Ctry: GB
-    AdrLine:
-      - 1 Oxford Street
-      - London
-      - UK
+    AdrTp: ADDR
+    Dept: Department
+    SubDept: Sub department
+    StrtNm: Street name
+    BldgNb: Building number
+    PstCd: Post code
+    TwnNm: Town name
+    CtrySubDvsn: Country subdivision
+    Ctry: Country
+    AdrLine: Address line

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml

@@ -4,14 +4,43 @@ description: |
   Provides the details to identify an account.
 properties:
   Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification for the account between the account owner and the
+      account servicer.
     $ref: ./AccountIdentification4Choice.yaml
   Tp:
+    description: >
+      Type
+
+      Specifies the nature, or use of the account.
     $ref: ./CashAccountType2Choice.yaml
   Ccy:
+    description: >
+      Currency
+
+      Definition: Identification of the currency in which the account is held.
+
+      Usage: Currency should only be used in case one and the same account number covers several
+      currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
     $ref: ./ActiveOrHistoricCurrencyCode.yaml
   Nm:
+    description: >
+      Name
+
+      Definition: Name of the account, as assigned by the account servicing institution, in agreement with the
+      account owner in order to provide an additional means of identification of the account.
+
+      Usage: The account name is different from the account owner name. The account name is used in
+      certain user communities to provide a means of identifying the account, in addition to the account
+      owner's identity and the account number.
     $ref: ./Max70Text.yaml
   Prxy:
+    description: >
+      Proxy
+
+      Specifies an alternate assumed name for the identification of the account.
     $ref: ./ProxyAccountIdentification1.yaml
 example:
   Id:

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Account type, in a coded form.
     $ref: ./ExternalCashAccountType1Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Nature or use of the account in a proprietary form.
     $ref: ./Max35Text.yaml
 oneOf:
   - required:

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml

@@ -5,8 +5,16 @@ description: >
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Category purpose, as published in an external category purpose code list.
     $ref: ./ExternalCategoryPurpose1Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Category purpose, in a proprietary form.
     $ref: ./Max35Text.yaml
 oneOf:
   - required:

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml

@@ -1,10 +1,21 @@
 title: ChargeType3Choice
-description: ChargeType3Choice Specifies the type of charge.
+description: >
+  ChargeType3Choice
+
+  Specifies the type of charge.
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Charge type, in a coded form.
     $ref: ./ExternalChargeType1Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Type of charge in a proprietary form, as defined by the issuer.
     $ref: ./GenericIdentification3.yaml
 oneOf:
   - required:

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml

@@ -1,13 +1,27 @@
 title: Charges16
 description: |
   NOTE: Unsure on description.
+
+  Seemingly a generic schema for charges, with an amount, agent, and type.
 type: object
 properties:
   Amt:
+    description: >
+      Amount
+
+       Transaction charges to be paid by the charge bearer.
     $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
   Agt:
+    description: >
+      Agent
+
+      Agent that takes the transaction charges or to which the transaction charges are due.
     $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
   Tp:
+    description: >
+      Type
+
+       Defines the type of charges.
     $ref: ./ChargeType3Choice.yaml
 required:
   - Amt

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml

@@ -4,8 +4,17 @@ description: |
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Identification of a member of a clearing system
     $ref: ./ExternalClearingSystemIdentification1Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Identification code for a clearing system, that has not yet been identified in the list of clearing
+      systems.
     $ref: ./Max35Text.yaml
 oneOf:
   - required:

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml

@@ -5,8 +5,17 @@ description: >
 type: object
 properties:
   ClrSysId:
+    description: >
+      ClearingSystemIdentification.
+
+      Specification of a pre-agreed offering between clearing agents or the channel through which
+      the payment instruction is processed.
     $ref: ./ClearingSystemIdentification2Choice.yaml
   MmbId:
+    description: >
+      MemberIdentification.
+
+      Identification of a member of a clearing system.
     $ref: ./Max35Text.yaml
 required:
   - MmbId

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml

@@ -4,30 +4,83 @@ description: |
 type: object
 properties:
   NmPrfx:
+    description: >
+      NamePrefix
+
+      Specifies the terms used to formally address a person.
     $ref: ./NamePrefix2Code.yaml
   Nm:
+    description: >
+      Name
+
+      Name by which a party is known and which is usually used to identify that party.
     $ref: ./Max140Text.yaml
   PhneNb:
+    description: >
+      PhoneNumber
+
+      Collection of information that identifies a phone number, as defined by telecom services.
     $ref: ./PhoneNumber.yaml
   MobNb:
+    description: >
+      MobilePhoneNumber
+
+      Collection of information that identifies a mobile phone number, as defined by telecom services.
     $ref: ./PhoneNumber.yaml
   FaxNb:
+    description: >
+      FaxNumber
+
+      Collection of information that identifies a fax number, as defined by telecom services.
     $ref: ./PhoneNumber.yaml
   URLAdr:
+    description: >
+      URLAddress
+
+      Address for the Universal Resource Locator (URL), for example an address used over the
+      www (HTTP) service.
     $ref: ./Max2048Text.yaml
   EmailAdr:
+    description: >
+      EmailAddress
+
+      Address for electronic mail (e-mail).
     $ref: ./Max256Text.yaml
   EmailPurp:
+    description: >
+      EmailPurpose
+
+      Purpose for which an email address may be used.
     $ref: ./Max35Text.yaml
   JobTitl:
+    description: >
+      JobTitle
+
+      Title of the function.
     $ref: ./Max35Text.yaml
   Rspnsblty:
+    description: >
+      Responsibility
+
+      Role of a person in an organisation.
     $ref: ./Max35Text.yaml
   Dept:
+    description: >
+      Department
+
+      Identification of a division of a large organisation or building.
     $ref: ./Max70Text.yaml
   Othr:
+    description: >
+      OtherContact
+
+      Contact details in another form.
     $ref: ./OtherContact1.yaml
   PrefrdMtd:
+    description: >
+      PreferredContactMethod
+
+      Preferred method used to reach the contact.
     $ref: ./PreferredContactMethod2Code.yaml
 example:
   NmPrfx: Mr