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

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

@@ -1,20 +1,50 @@
 title: StructuredRegulatoryReporting3
 description: |
-  Unsure on description.
+  StructuredRegulatoryReporting3
+
+  Information needed due to regulatory and statutory requirements.
 type: object
 properties:
   Tp:
+    description: |
+      Type
+
+      Specifies the type of the information supplied in the regulatory reporting details.
     $ref: ./Max35Text.yaml
   Dt:
+    description: |
+      Date
+
+      Date related to the specified type of regulatory reporting details.
     $ref: ./ISODate.yaml
   Ctry:
+    description: |
+      Country
+
+      Country related to the specified type of regulatory reporting details.
     $ref: ./CountryCode.yaml
   Cd:
+    description: >
+      Code
+
+      Specifies the nature, purpose, and reason for the transaction to be reported
+      for regulatory and statutory requirements in a coded form.
     $ref: ./Max10Text.yaml
   Amt:
+    description: |
+      Amount
+
+      Amount of money to be reported for regulatory and statutory requirements.
     $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
   Inf:
-    $ref: ./Max35Text.yaml
+    description: |
+      Information
+      Additional details that cater for specific domestic regulatory requirements.
+    anyOf:
+      - $ref: ./Max35Text.yaml
+      - items:
+          $ref: ./Max35Text.yaml
+        type: array
 example:
   Tp: T1
   Dt: '2018-01-01'

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

@@ -5,8 +5,20 @@ description: >
 type: object
 properties:
   PlcAndNm:
+    description: >
+      PlaceAndName
+
+      Unambiguous reference to the location where the supplementary data must be inserted in
+      the message instance.
     $ref: ./Max350Text.yaml
   Envlp:
+    description: >
+      Envelope
+
+      Technical element wrapping the supplementary data.
+
+      Technical component that contains the validated supplementary data information. This technical
+      envelope allows to segregate the supplementary data information from any other information.
     $ref: ./SupplementaryDataEnvelope1.yaml
 required:
   - Envlp

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

@@ -1,5 +1,8 @@
 title: SupplementaryDataEnvelope1
-description: |
-  Unsure on description.
+description: >
+  SupplementaryDataEnvelope1
+
+  Technical component that contains the validated supplementary data information.
+  This technical envelope allows to segregate the supplementary data information from any other information.
 type: object
 

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

@@ -4,13 +4,33 @@ description: |
 type: object
 properties:
   Rate:
+    description: |
+      Rate
+
+      Rate used to calculate the tax.
     $ref: ./PercentageRate.yaml
   TaxblBaseAmt:
+    description: |
+      TaxableBaseAmount
+
+      Amount of money on which the tax is based.
     $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
   TtlAmt:
+    description: |
+      TotalAmount
+
+      Total amount that is the result of the calculation of the tax for the record.
     $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
   Dtls:
-    $ref: ./TaxRecordDetails3.yaml
+    description: |
+      Details
+
+      Set of elements used to provide details on the tax period and amount.
+    anyOf:
+      - $ref: ./TaxRecordDetails3.yaml
+      - items:
+          $ref: ./TaxRecordDetails3.yaml
+        type: array
 example:
   Rate: 0.0
   TaxblBaseAmt:

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

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   Titl:
+    description: |
+      Title
+
+      Title or position of debtor or the debtor's authorised representative.
     $ref: ./Max35Text.yaml
   Nm:
+    description: |
+      Name
+
+      Name of the debtor or the debtor's authorised representative.
     $ref: ./Max140Text.yaml
 example:
   Titl: Mr

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

@@ -5,27 +5,75 @@ description: >
 type: object
 properties:
   Cdtr:
+    description: |
+      Creditor
+
+      Party on the credit side of the transaction to which the tax applies.
     $ref: ./TaxParty1.yaml
   Dbtr:
+    description: |
+      Debtor
+
+      Party on the debit side of the transaction to which the tax applies.
     $ref: ./TaxParty2.yaml
   UltmtDbtr:
+    description: |
+      UltimateDebtor
+
+      Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.
     $ref: ./TaxParty2.yaml
   AdmstnZone:
+    description: |
+      AdministrationZone
+
+      Territorial part of a country to which the tax payment is related.
     $ref: ./Max35Text.yaml
   RefNb:
+    description: |
+      ReferenceNumber
+
+      Tax reference information that is specific to a taxing agency.
     $ref: ./Max140Text.yaml
   Mtd:
+    description: |
+      Method
+
+      Method used to indicate the underlying business or how the tax is paid.
     $ref: ./Max35Text.yaml
   TtlTaxblBaseAmt:
+    description: |
+      TotalTaxableBaseAmount
+
+      Total amount of money on which the tax is based.
     $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
   TtlTaxAmt:
+    description: |
+      TotalTaxAmount
+
+      Total amount of money as result of the calculation of the tax.
     $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
   Dt:
+    description: |
+      Date
+
+      Date by which tax is due.
     $ref: ./ISODate.yaml
   SeqNb:
+    description: |
+      SequenceNumber
+
+      Sequential number of the tax report
     $ref: ./Number.yaml
   Rcrd:
-    $ref: ./TaxRecord3.yaml
+    description: |
+      Record
+
+      Details of the tax record.
+    anyOf:
+      - $ref: ./TaxRecord3.yaml
+      - items:
+          $ref: ./TaxRecord3.yaml
+        type: array
 example:
   Cdtr:
     Titl: Mr

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

@@ -4,10 +4,22 @@ description: |
 type: object
 properties:
   TaxId:
+    description: |
+      TaxIdentification
+
+      Tax identification number of the creditor.
     $ref: ./Max35Text.yaml
   RegnId:
+    description: |
+      RegistrationIdentification
+
+      Unique identification, as assigned by an organisation, to unambiguously identify a party.
     $ref: ./Max35Text.yaml
   TaxTp:
+    description: |
+      TaxType
+
+      Type of tax payer.
     $ref: ./Max35Text.yaml
 example:
   TaxId: 123456789

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

@@ -4,12 +4,28 @@ description: |
 type: object
 properties:
   TaxId:
+    description: |
+      TaxIdentification
+
+      Tax identification number of the debtor.
     $ref: ./Max35Text.yaml
   RegnId:
+    description: |
+      RegistrationIdentification
+
+      Unique identification, as assigned by an organisation, to unambiguously identify a party.
     $ref: ./Max35Text.yaml
   TaxTp:
+    description: |
+      TaxType
+
+      Type of tax payer.
     $ref: ./Max35Text.yaml
   Authstn:
+    description: |
+      Authorisation
+
+      Details of the authorised tax paying party.
     $ref: ./TaxAuthorisation1.yaml
 example:
   TaxId: 123456789

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

@@ -3,12 +3,24 @@ description: |
   Period of time details related to the tax payment.
 type: object
 properties:
-  Yr:
-    $ref: ./ISOYear.yaml
-  Tp:
-    $ref: ./TaxRecordPeriod1Code.yaml
   FrToDt:
     $ref: ./DatePeriod2.yaml
+    description: |
+      FromToDate
+
+      Range of time between a start date and an end date for which the tax report is provided.
+  Tp:
+    $ref: ./TaxRecordPeriod1Code.yaml
+    description: |
+      Type
+
+      Identification of the period related to the tax payment.
+  Yr:
+    $ref: ./ISOYear.yaml
+    description: |
+      Year
+
+      Year related to the tax payment.
 example:
   Yr: 2020
   Tp: MM01

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

@@ -3,24 +3,60 @@ description: |
   Set of elements used to define the tax record.
 type: object
 properties:
-  Tp:
+  AddtlInf:
+    $ref: ./Max140Text.yaml
+    description: |
+      AdditionalInformation
+
+      Further details of the tax record.
+  CertId:
     $ref: ./Max35Text.yaml
+    description: |
+      CertificateIdentification
+
+      Identification number of the tax report as assigned by the taxing authority.
   Ctgy:
     $ref: ./Max35Text.yaml
+    description: |
+      Category
+
+      Specifies the tax code as published by the tax authority.
   CtgyDtls:
     $ref: ./Max35Text.yaml
+    description: |
+      CategoryDetails
+
+      Provides further details of the category tax code.
   DbtrSts:
     $ref: ./Max35Text.yaml
-  CertId:
-    $ref: ./Max35Text.yaml
+    description: |
+      DebtorStatus
+
+      Code provided by local authority to identify the status of the party that has drawn up the settlement document.
   FrmsCd:
     $ref: ./Max35Text.yaml
+    description: |
+      FormsCode
+
+      Identifies, in a coded form, on which template the tax report is to be provided.
   Prd:
     $ref: ./TaxPeriod3.yaml
+    description: |
+      Period
+
+      Set of elements used to provide details on the period of time related to the tax payment.
   TaxAmt:
     $ref: ./TaxAmount3.yaml
-  AddtlInf:
-    $ref: ./Max140Text.yaml
+    description: |
+      TaxAmount
+
+      Set of elements used to provide information on the amount of the tax record.
+  Tp:
+    $ref: ./Max35Text.yaml
+    description: |
+      Type
+
+      High level code to identify the type of tax details.
 example:
   Tp: VAT
   Ctgy: A

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

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   Prd:
+    description: |
+      Period
+
+      Set of elements used to provide details on the period of time related to the tax payment.
     $ref: ./TaxPeriod3.yaml
   Amt:
+    description: |
+      Amount
+
+      Underlying tax amount related to the specified period.
     $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
 required:
   - Amt

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

@@ -2,8 +2,17 @@ title: VerificationReason1Choice
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Reason why the verified identification information is incorrect, as published in an external
+      reason code list.
     $ref: ./ExternalVerificationReason1Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Reason why the verified identification information is incorrect, in a free text form.
     $ref: ./Max35Text.yaml
 oneOf:
   - required:

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

@@ -2,28 +2,76 @@ title: VerificationReport4
 type: object
 properties:
   OrgnlId:
+    description: >
+      OriginalIdentification
+
+      Unique identification, as assigned by a sending party, to unambiguously identify the party
+      and account identification information group within the original message.
     $ref: ./Max35Text.yaml
   Vrfctn:
+    description: >
+      Verification
+
+      Identifies whether the party and/or account information received is correct.
+      Boolean value.
     $ref: ./IdentificationVerificationIndicator.yaml
   Rsn:
+    description: >
+      Reason.
+
+      Specifies the reason why the verified identification information is incorrect.
     $ref: ./VerificationReason1Choice.yaml
   OrgnlPtyAndAcctId:
+    description: >
+      OriginalPartyAndAccountIdentification
+
+      Provides party and/or account identification information as given in the original message.
     $ref: ./IdentificationInformation4.yaml
   UpdtdPtyAndAcctId:
+    description: >
+      UpdatedPartyAndAccountIdentification
+
+      Provides party and/or account identification information.
     $ref: ./IdentificationInformation4.yaml
 required:
   - OrgnlId
   - Vrfctn
 example:
-  OrgnlId: 123456789
+  OrgnlId: 1234567890123456789012345678901234
   Vrfctn: true
-  Rsn:
-    Cd: AGNT
   OrgnlPtyAndAcctId:
-    Id: 123456789
-    SchmeNm:
-      Cd: CCPT
+    Nm: John Doe
+    PstlAdr:
+      AdrTp: ADDR
+      Dept: Dept
+      SubDept: SubDept
+      StrtNm: 1234 Elm St
+      BldgNb: 1234
+      PstCd: 12345
+      TwnNm: Anytown
+      CtrySubDvsn: CA
+      Ctry: US
+    Id:
+      OrgId:
+        AnyBIC: ABCDUS33
+        Othr:
+          Id: 123456789
+          Issr: ABA
   UpdtdPtyAndAcctId:
-    Id: 123456789
-    SchmeNm:
-      Cd: CCPT
+    Nm: John Doe
+    PstlAdr:
+      AdrTp: ADDR
+      Dept: Dept
+      SubDept: SubDept
+      StrtNm: 1234 Elm St
+      BldgNb: 1234
+      PstCd: 12345
+      TwnNm: Anytown
+      CtrySubDvsn: CA
+      Ctry: US
+    Id:
+      OrgId:
+        AnyBIC: ABCDUS33
+        Othr:
+          Id: 123456789
+          Issr: ABA

package/fspiop/v2_0_ISO20022/openapi3/openapi.yaml

@@ -1,4 +1,4 @@
-openapi: 3.0.2
+openapi: 3.1.0
 info:
   version: v2.0-iso20022-draft
   title: Open API for FSP Interoperability (FSPIOP) - the ISO 20022 message version