@mojaloop/api-snippets 17.6.0 → 17.6.1

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

@@ -4,26 +4,61 @@ description: |
 type: object
 properties:
   Nm:
+    description: >
+      Name
+
+      Name by which a party is known and which is usually used to identify that party.
     $ref: ./Max140Text.yaml
   PstlAdr:
+    description: >
+      PostalAddress
+
+      Information that locates and identifies a specific address, as defined by postal services.
     $ref: ./PostalAddress24.yaml
   Id:
+    description: >
+      Identification
+
+      Unique and unambiguous way to identify an organisation.
     $ref: ./Party38Choice.yaml
   CtryOfRes:
+    description: >
+      CountryOfResidence
+      Country in which a person resides (the place of a person's home). In the case of a company,
+      it is the country from which the affairs of that company are directed.
     $ref: ./CountryCode.yaml
   CtctDtls:
+    description: >
+      ContactDetails
+
+      Set of elements used to indicate how to contact the party.
     $ref: ./Contact4.yaml
 example:
   Nm: John Doe
   PstlAdr:
-    Ctry: BE
-    AdrLine:
-      - Rue du Marché 45
-      - Brussels
-      - BE
+    AdrTp: ADDR
+    Dept: Dept
+    SubDept: SubDept
+    StrtNm: StrtNm
+    BldgNb: BldgNb
+    BldgNm: BldgNm
+    Flr: Flr
+    PstBx: PstBx
+    Room: Room
+    PstCd: PstCd
+    TwnNm: TwnNm
+    TwnLctnNm: TwnLctnNm
+    DstrctNm: DstrctNm
+    CtrySubDvsn: CtrySubDvsn
+    Ctry: Ctry
+    AdrLine: AdrLine
   Id:
     OrgId:
-      AnyBIC: CCCCUS33
+      Othr:
+        Id: 123
+        SchmeNm:
+          Prtry: DfspId
+
   CtryOfRes: BE
   CtctDtls:
     NmPrfx: Mr
@@ -31,4 +66,5 @@ example:
     PhneNb: +123-123-321
     MobNb: +123-123-321
     FaxNb: +123-123-321
-    EmailAdr:
+    EmailAdr: example@example.com
+

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

@@ -4,14 +4,35 @@ description: |
 type: object
 properties:
   Nm:
+    description: >
+      Name
+
+      Name by which a party is known and which is usually used to identify that party.
     $ref: ./Max140Text.yaml
   PstlAdr:
+    description: >
+      Postal Address
+
+      Information that locates and identifies a specific address, as defined by postal services.
     $ref: ./PostalAddress27.yaml
   Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification of a party.
     $ref: ./Party52Choice.yaml
   CtryOfRes:
+    description: >
+      Country of Residence
+
+      Country in which a person resides (the place of a person's home).
+      In the case of a company, it is the country from which the affairs of that company are directed.
     $ref: ./CountryCode.yaml
   CtctDtls:
+    description: >
+      Contact Details
+
+      Set of elements used to indicate how to contact the party.
     $ref: ./Contact13.yaml
 example:
   Nm: John Doe

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

@@ -4,14 +4,53 @@ description: |
 type: object
 properties:
   InstrId:
+    description: >
+      InstructionIdentification
+
+      Definition: Unique identification, as assigned by an instructing party for an instructed party, to
+      unambiguously identify the instruction.
+
+      Usage: The instruction identification is a point to point reference that can be used between the
+      instructing party and the instructed party to refer to the individual instruction. It can be included in
+      several messages related to the instruction.
     $ref: ./Max35Text.yaml
   EndToEndId:
+    description: >
+      EndToEndIdentification
+
+      Definition: Unique identification, as assigned by the initiating party, to unambiguously identify the
+      transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
+
+      Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the
+      transaction. It can be included in several messages related to the transaction.
+
+      Usage: In case there are technical limitations to pass on multiple references, the end-to-end
+      identification must be passed on throughout the entire end-to-end chain.
     $ref: ./Max35Text.yaml
   TxId:
+    description: >
+      TransactionIdentification
+
+      Definition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the
+      transaction that is passed on, unchanged, throughout the entire interbank chain.
+
+      Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to
+      the transaction on the interbank level.
+
+      Usage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.
     $ref: ./Max35Text.yaml
   UETR:
+    description: >
+      UETR
+
+      Universally unique identifier to provide an end-to-end reference of a payment transaction.
     $ref: ./UUIDv4Identifier.yaml
   ClrSysRef:
+    description: >
+      ClearingSystemReference
+
+      Unique reference, as assigned by a clearing system, to unambiguously identify the
+      instruction.
     $ref: ./Max35Text.yaml
 required:
   - EndToEndId

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

@@ -4,14 +4,38 @@ description: |
 type: object
 properties:
   InstrPrty:
+    description: >
+      InstructionPriority
+
+      Indicator of the urgency or order of importance that the instructing party would like the
+      instructed party to apply to the processing of the instruction.
     $ref: ./Priority2Code.yaml
   ClrChanl:
+    description: >
+      ClearingChannel
+
+      Specifies the clearing channel to be used to process the payment instruction.
     $ref: ./ClearingChannel2Code.yaml
   SvcLvl:
+    description: >
+      ServiceLevel
+
+      Agreement under which or rules under which the transaction should be processed.
     $ref: ./ServiceLevel8Choice.yaml
   LclInstrm:
+    description: >
+      LocalInstrument
+
+      Definition: User community specific instrument.
+
+      Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the
+      service or service level.
     $ref: ./LocalInstrument2Choice.yaml
   CtgyPurp:
+    description: >
+      CategoryPurpose
+
+      Specifies the high level purpose of the instruction based on a set of pre-defined categories.
     $ref: ./CategoryPurpose1Choice.yaml
 example:
   InstrPrty: NORM

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

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   DtAndPlcOfBirth:
+    description: >
+      DateAndPlaceOfBirth
+
+      Date and place of birth of a person.
     $ref: ./DateAndPlaceOfBirth1.yaml
   Othr:
+    description: >
+      Other
+
+      Unique identification of a person, as assigned by an institution, using an identification scheme.
     $ref: ./GenericPersonIdentification1.yaml
 example:
   DtAndPlcOfBirth:

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

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   DtAndPlcOfBirth:
+    description: >
+      DateAndPlaceOfBirth
+
+      Date and place of birth of a person.
     $ref: ./DateAndPlaceOfBirth1.yaml
   Othr:
+    description: >
+      Other
+
+      Unique identification of a person, as assigned by an institution, using an identification scheme.
     $ref: ./GenericPersonIdentification2.yaml
 example:
   DtAndPlcOfBirth:

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

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Name of the identification scheme, in a coded form as published in an external list
     $ref: ./ExternalPersonIdentification1Code.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/ProxyAccountIdentification1.yaml

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   Tp:
+    description: |
+      Type
+
+      Type of the proxy identification.
     $ref: ./ProxyAccountType1Choice.yaml
   Id:
+    description: |
+      Identification
+
+      Identification used to indicate the account identification under another specified name.
     $ref: ./Max2048Text.yaml
 required:
   - Id

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

@@ -1,11 +1,21 @@
 title: ProxyAccountType1Choice
 type: object
 description: |
-  NOTE: Unsure on description.
+  ProxyAccountType1Choice
+
+  Specifies the scheme used for the identification of an account alias.
 properties:
   Cd:
+    description: |
+      Code
+
+      Name of the identification scheme, in a coded form as published in an external list.
     $ref: ./ExternalProxyAccountType1Code.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/Purpose2Choice.yaml

@@ -9,8 +9,16 @@ description: >
 type: object
 properties:
   Cd:
+    description: |
+      Code
+
+      Underlying reason for the payment transaction, as published in an external purpose code list.
     $ref: ./ExternalPurpose1Code.yaml
   Prtry:
+    description: |
+      Proprietary
+
+      Purpose, in a proprietary form.
     $ref: ./Max35Text.yaml
 oneOf:
   - required:

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

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   Nm:
+    description: |
+      Name
+
+      Name of the entity requiring the regulatory reporting information.
     $ref: ./Max140Text.yaml
   Ctry:
+    description: |
+      Country
+
+      Country of the entity that requires the regulatory reporting information.
     $ref: ./CountryCode.yaml
 example:
   Nm: Swiss National Bank

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

@@ -4,11 +4,29 @@ description: |
 type: object
 properties:
   DbtCdtRptgInd:
+    description: >
+      DebitCreditReportingIndicator
+
+      Identifies whether the regulatory reporting information applies to the debit side,
+      to the credit side or to both debit and credit sides of the transaction.
     $ref: ./RegulatoryReportingType1Code.yaml
   Authrty:
+    description: |
+      Authority
+
+      Entity requiring the regulatory reporting information.
     $ref: ./RegulatoryAuthority2.yaml
   Dtls:
-    $ref: ./StructuredRegulatoryReporting3.yaml
+    description: >
+      Details
+
+      Identifies whether the regulatory reporting information applies to the debit side,
+      to the credit side or to both debit and credit sides of the transaction.
+    anyOf:
+      - $ref: ./StructuredRegulatoryReporting3.yaml
+      - items:
+          $ref: ./StructuredRegulatoryReporting3.yaml
+        type: array
 example:
   DbtCdtRptgInd: CRED
   Authrty:

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

@@ -4,8 +4,17 @@ description: |
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Specifies a pre-agreed service or level of service between the parties,
+      as published in an external service level code list.
     $ref: ./ExternalServiceLevel1Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Specifies a pre-agreed service or level of service between the parties, as a proprietary code.
     $ref: ./Max35Text.yaml
 oneOf:
   - required:

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

@@ -1,11 +1,18 @@
 title: SettlementInstruction15
 description: |
-  NOTE: Unsure on description.
+  Specifies the details on how the settlement of the original transaction(s) between the
+  instructing agent and the instructed agent was completed.
 type: object
 properties:
   SttlmMtd:
+    description: >
+      SettlementMethod
+
+      Method used to settle the (batch of) payment instructions.
     $ref: ./SettlementMethod1Code.yaml
   PmtTpInf:
+    description: |
+      PaymentTypeInformation
     $ref: ./PaymentTypeInformation28.yaml
 required:
   - SttlmMtd

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

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Reason for the status, as published in an external reason code list.
     $ref: ./ExternalStatusReason1Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Reason for the status, in a proprietary form.
     $ref: ./Max35Text.yaml
 oneOf:
   - required:

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

@@ -4,10 +4,22 @@ description: |
 type: object
 properties:
   Orgtr:
+    description:
+      Originator
+
+      Party that issues the status.
     $ref: ./PartyIdentification272.yaml
   Rsn:
+    description:
+      Reason
+
+      Specifies the reason for the status report.
     $ref: ./StatusReason6Choice.yaml
   AddtlInf:
+    description:
+      AdditionalInformation
+
+      Additional information about the status report.
     $ref: ./Max105Text.yaml
 example:
   Orgtr:

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