@mojaloop/api-snippets 17.6.0 → 17.6.1

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

@@ -2,10 +2,22 @@ title: GenericOrganisationIdentification1
 type: object
 properties:
   Id:
+    description: >
+      Identification
+
+      Identification assigned by an institution.
     $ref: ./Max35Text.yaml
   SchmeNm:
+    description: >
+      SchemeName
+
+      Name of the identification scheme.
     $ref: ./OrganisationIdentificationSchemeName1Choice.yaml
   Issr:
+    description: >
+      Issuer
+
+      Entity that assigns the identification.
     $ref: ./Max35Text.yaml
 required:
   - Id

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

@@ -2,10 +2,22 @@ title: GenericOrganisationIdentification3
 type: object
 properties:
   Id:
+    description: >
+      Identification
+
+      Identification assigned by an institution.
     $ref: ./Max256Text.yaml
   SchmeNm:
+    description:
+      SchemeName
+
+      Name of the identification scheme.
     $ref: ./OrganisationIdentificationSchemeName1Choice.yaml
   Issr:
+    description: >
+      Issuer
+
+      Entity that assigns the identification.
     $ref: ./Max35Text.yaml
 required:
   - Id

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

@@ -2,10 +2,22 @@ title: GenericPersonIdentification1
 type: object
 properties:
   Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification of a person.
     $ref: ./Max35Text.yaml
   SchmeNm:
+    description: >
+      SchemeName
+
+      Name of the identification scheme.
     $ref: ./PersonIdentificationSchemeName1Choice.yaml
   Issr:
+    description: >
+      Issuer
+
+      Entity that assigns the identification.
     $ref: ./Max35Text.yaml
 required:
   - Id

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

@@ -2,10 +2,22 @@ title: GenericPersonIdentification2
 type: object
 properties:
   Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification of a person.
     $ref: ./Max256Text.yaml
   SchmeNm:
+    description: >
+      SchemeName
+
+      Name of the identification scheme.
     $ref: ./PersonIdentificationSchemeName1Choice.yaml
   Issr:
+    description: >
+      Issuer
+
+      Entity that assigns the identification.
     $ref: ./Max35Text.yaml
 required:
   - Id

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

@@ -2,10 +2,23 @@ title: GetPartiesError_IdentificationVerificationReportV03
 type: object
 properties:
   Assgnmt:
+    description: >
+      Assignment
+
+      Information related to the identification assignment.
     $ref: ./IdentificationAssignment3.yaml
   Rpt:
+    description: >
+      Report
+
+      Information concerning the verification of the identification data for which verification was
+      requested.
     $ref: ./VerificationReport4.yaml
   SplmtryData:
+    description: >
+      SupplementaryData
+
+      Additional information that cannot be captured in the structured elements and/or any other specific block.
     $ref: ./SupplementaryData1.yaml
 required:
   - Assgnmt

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

@@ -2,56 +2,76 @@ title: GetParties_IdentificationVerificationReportV03
 type: object
 properties:
   Assgnmt:
+    description: >
+      Assignment
+
+      Identifies the identification assignment.
     $ref: ./IdentificationAssignment3.yaml
   Rpt:
+    description: >
+      Report
+
+      Information concerning the verification of the identification data for which verification was
+      requested.
     $ref: ./VerificationReport4.yaml
   SplmtryData:
+    description: >
+      SupplementaryData
+
+      Additional information that cannot be captured in the structured elements and/or any other specific block.
     $ref: ./SupplementaryData1.yaml
 required:
   - Assgnmt
   - Rpt
 example:
   Assgnmt:
-    Id: 123
-    CreDtTm: '2013-03-07T16:30:00'
+    MsgId: 123
+    CreDtTm: '2020-01-01T00:00:00Z'
     Assgnr:
-      Id:
-        Id: 123
-        SchmeNm:
-          Cd: IBAN
-        Issr: BIC
+      OrgId:
+        Othr:
+          Id: 123
+          SchmeNm:
+            Cd: BIC
+          Issr: BIC
     Assgne:
-      Id:
-        Id: 123
-        SchmeNm:
-          Cd: IBAN
-        Issr: BIC
+      OrgId:
+        Othr:
+          Id: DFSPID
   Rpt:
-    Id: 123
-    CreDtTm: '2013-03-07T16:30:00'
-    RptgPty:
-      Id:
-        Id: 123
-        SchmeNm:
-          Cd: IBAN
-        Issr: BIC
-    RptdPty:
-      Id:
-        Id: 123
-        SchmeNm:
-          Cd: IBAN
-        Issr: BIC
-    RptdDoc:
-      Nb: 123
-      RltdDt: '2013-03-07'
-      RltdDtTp:
-        Cd: 123
-    Rsn:
-      Cd: 123
-      Prtry: 123
-  SplmtryData:
-    PlcAndNm: 123
-    Envlp: 123
-    RltdDt: '2013-03-07'
-    RltdDtTp:
-      Cd: 123
+    OrgnlId: 12345678
+    Vrfctn: true
+    UpdtdPtyAndAcctId:
+      Pty:
+        Nm: John Doe
+        PstlAdr:
+          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:
+            Othr:
+              Id: 18761231234
+            SchmeNm:
+              Prtry: MSISDN
+        CtryOfRes: BE
+        CtctDtls:
+          NmPrfx: Mr
+          Nm: John Doe
+          PhneNb: +123-123-321
+          MobNb: +123-123-321
+          FaxNb: +123-123-321
+          EmailAdr: example@example.com

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

@@ -5,10 +5,29 @@ description: >
 type: object
 properties:
   MsgId:
+    description: >
+      MessageIdentification
+
+      Definition: Point to point reference, as assigned by the instructing party, and sent to the next party in the
+      chain to unambiguously identify the message.
+
+      Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party
+      for a pre-agreed period.
     $ref: ./Max35Text.yaml
   CreDtTm:
+    description: >
+      CreationDateTime
+
+      Date and time at which the message was created.
     $ref: ./ISODateTime.yaml
   TxInfAndSts:
+    description: >
+      TransactionInformationAndStatus
+
+      Definition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).
+
+      Usage: The instructing agent is the party sending the status message and not the party that sent the
+      original instruction that is being reported on.
     $ref: ./PaymentTransaction163.yaml
 required:
   - MsgId

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

@@ -4,10 +4,24 @@ properties:
   MsgId:
     $ref: ./Max35Text.yaml
   CreDtTm:
+    description: >
+      CreationDateTime
+
+      Date and time at which the identification assignment was created.
     $ref: ./ISODateTime.yaml
   Assgnr:
+    description: >
+      Assignor
+
+      Party that assigns the identification assignment to another party. This is also the sender of
+      the message.
     $ref: ./Party40Choice.yaml
   Assgne:
+    description: >
+      Assignee
+
+      Party that the identification assignment is assigned to. This is also the receiver of the
+      message.
     $ref: ./Party40Choice.yaml
 required:
   - MsgId

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

@@ -2,10 +2,22 @@ title: IdentificationInformation4
 type: object
 properties:
   Pty:
+    description: >
+      Party
+
+      Account owner that owes an amount of money or to whom an amount of money is due.
     $ref: ./PartyIdentification135.yaml
   Acct:
+    description: >
+      Account
+
+      Unambiguous identification of the account of a party.
     $ref: ./CashAccount40.yaml
   Agt:
+    description: >
+      Agent
+
+      Financial institution servicing an account for a party.
     $ref: ./BranchAndFinancialInstitutionIdentification6.yaml
 example:
   Pty:

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

@@ -1,3 +1,8 @@
 title: IdentificationVerificationIndicator
 type: boolean
 example: true
+description: |
+  Definition: Identifies whether the party and/or account information received is correct.
+
+  • Meaning When True: Indicates that the identification information received is correct.
+  • Meaning When False: Indicates that the identification information received is incorrect

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

@@ -5,8 +5,18 @@ description: >
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Coded information related to the processing of the payment instruction, provided by the
+      initiating party, and intended for the creditor's agent.
     $ref: ./ExternalCreditorAgentInstruction1Code.yaml
   InstrInf:
+    description: >
+      InstructionInformation
+
+      Further information complementing the coded instruction or instruction to the creditor's agent
+      that is bilaterally agreed or specific to a user community.
     $ref: ./Max140Text.yaml
 example:
   Cd: PHOA

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

@@ -5,8 +5,18 @@ description: >
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Coded information related to the processing of the payment instruction, provided by the
+      initiating party, and intended for the next agent in the payment chain.
     $ref: ./Instruction4Code.yaml
   InstrInf:
+    description: >
+      InstructionInformation
+
+      Further information complementing the coded instruction or instruction to the next agent that
+      is bilaterally agreed or specific to a user community.
     $ref: ./Max140Text.yaml
 example:
   Cd: PHOA

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

@@ -2,8 +2,16 @@ title: LocalInstrument2Choice
 type: object
 properties:
   Cd:
+    description: >
+      Code
+
+      Specifies the local instrument, as published in an external local instrument code list.
     $ref: ./ExternalLocalInstrument1Code.yaml
   Prtry:
+    description: >
+      Proprietary
+
+      Specifies the local instrument, as a proprietary code
     $ref: ./Max35Text.yaml
 oneOf:
   - required:

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

@@ -4,10 +4,22 @@ description: |
 type: object
 properties:
   AnyBIC:
+    description: >
+      AnyBIC
+
+      Business identification code of the organisation.
     $ref: ./AnyBICDec2014Identifier.yaml
   LEI:
+    description: >
+      LEI
+
+      Legal entity identification as an alternate identification for a party.
     $ref: ./LEIIdentifier.yaml
   Othr:
+    description: >
+      Other
+
+      Unique identification of an organisation, as assigned by an institution, using an identification scheme.
     $ref: ./GenericOrganisationIdentification1.yaml
 example:
   AnyBIC: BICFI

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

@@ -4,10 +4,22 @@ description: |
 type: object
 properties:
   AnyBIC:
+    description: >
+      AnyBIC
+
+      Business identification code of the organisation.
     $ref: ./AnyBICDec2014Identifier.yaml
   LEI:
+    description: >
+      LEI
+
+      Legal entity identification as an alternate identification for a party.
     $ref: ./LEIIdentifier.yaml
   Othr:
+    description: >
+      Other
+
+      Unique identification of an organisation, as assigned by an institution, using an identification scheme.
     $ref: ./GenericOrganisationIdentification3.yaml
 example:
   AnyBIC: BICFI

package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.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: ./ExternalOrganisationIdentification1Code.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/OtherContact1.yaml

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   ChanlTp:
+    description: >
+      ChannelType
+
+      Method used to contact the financial institution's contact for the specific tax region.
     $ref: ./Max4Text.yaml
   Id:
+    description: >
+      Identifier
+
+      Communication value such as phone number or email address.
     $ref: ./Max128Text.yaml
 required:
   - ChanlTp

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

@@ -9,71 +9,22 @@ required:
   - GrpHdr
 example:
   GrpHdr:
-    MsgId: 123
+    MsgId: 12345
     CreDtTm: '2020-01-01T00:00:00Z'
-    NbOfTxs: 1
-    SttlmInf:
-      SttlmMtd: INDA
-      SttlmDt: '2020-01-01'
-      SttlmTmIndctn: RTGS
-      SttlmTmReq: '2020-01-01T00:00:00Z'
-      SttlmAcct:
-        Id:
-          Othr:
-            Id: 123
-            SchmeNm:
-              Cd: IBAN
-            Issr: BIC
-      ClrSys:
-        Prtry: 123
-      InstgAgt:
-        FinInstnId:
-          BICFI: 123
-      InstdAgt:
-        FinInstnId:
-          BICFI: 123
-    InstgAgt:
-      FinInstnId:
-        BICFI: 123
-    InstdAgt:
-      FinInstnId:
-        BICFI: 123
-    IntrBkSttlmAmt:
-      Amt: 123
-      Ccy: EUR
-    IntrBkSttlmDt: '2020-01-01'
-    TxSts: ACCP
-    StsRsnInf:
-      Orgtr:
-        Id:
-          Othr:
-            Id: 123
-            SchmeNm:
-              Cd: IBAN
-            Issr: BIC
-      Rsn:
-        Cd: 123
-        Prtry: 123
     TxInfAndSts:
-      OrgnlInstrId: 123
-      OrgnlEndToEndId: 123
-      TxSts: ACCP
+      StsId: 12345
+      OrgnlInstrId: 12345
+      OrgnlEndToEndId: 12345
+      OrgnlTxId: 12345
+      OrgnlUETR: 123e4567-e89b-12d3-a456-426614174000
+      TxSts: RJCT
       StsRsnInf:
-        Orgtr:
-          Id:
-            Othr:
-              Id: 123
-              SchmeNm:
-                Cd: IBAN
-              Issr: BIC
-        Rsn:
-          Cd: 123
-          Prtry: 123
-      ChrgsInf:
-        Amt: 123
-        Ccy: EUR
-      IntrBkSttlmAmt:
-        Amt: 123
-        Ccy: EUR
-      IntrBkSttlmDt: '2020-01-01'
-      SttlmTmIndctn: RTGS
+        Rsn: RSN
+        AddtlInf: ADDITIONAL
+      AccptncDtTm: '2020-01-01T00:00:00Z'
+      AcctSvcrRef: ACCTSVCRREF
+      ClrSysRef: CLRSYSREF
+      ExctnConf: 1234567890ABCDEF
+      SplmtryData:
+        PlcAndNm: PLACE
+        Envlp: ENVELOPE

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

@@ -4,8 +4,16 @@ description: |
 type: object
 properties:
   OrgId:
+    description: >
+      Organisation
+
+      Unique and unambiguous way to identify an organisation.
     $ref: ./OrganisationIdentification29.yaml
   PrvtId:
+    description: >
+      PrivateIdentification
+
+      Unique and unambiguous identification of a person, for example a passport.
     $ref: ./PersonIdentification13.yaml
 oneOf:
   - required:

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

@@ -1,11 +1,19 @@
 title: Party40Choice
 description: |
-  Nature or use of the account.
+   Identification of a person, an organisation or a financial institution.
 type: object
 properties:
   Pty:
+    description: >
+      Party
+
+      Identification of a person or an organisation.
     $ref: ./PartyIdentification135.yaml
   Agt:
+    description: >
+      Agent
+
+      Identification of a financial institution.
     $ref: ./BranchAndFinancialInstitutionIdentification6.yaml
 oneOf:
   - required:

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

@@ -1,11 +1,19 @@
 title: Party52Choice
 description: |
-  Nature or use of the account.
+  NOTE: Unsure on the description.
 type: object
 properties:
   OrgId:
+    description: >
+      Organisation
+
+      Unique and unambiguous way to identify an organisation.
     $ref: ./OrganisationIdentification39.yaml
   PrvtId:
+    description: >
+      Person
+
+      Unique and unambiguous identification of a person, for example a passport
     $ref: ./PersonIdentification18.yaml
 oneOf:
   - required: