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

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

@@ -2,82 +2,84 @@ title: FxRequest_FICreditTransferProposal
 type: object
 properties:
   GrpHdr:
+    description: >
+      GroupHeader
+
+      Set of characteristics shared by all individual transactions included in the message.
     $ref: ./GroupHeader113.yaml
 required:
   - GrpHdr
 example:
   GrpHdr:
-    MsgId: 123456789
+    MsgId: 12345
     CreDtTm: '2020-01-01T00:00:00Z'
     NbOfTxs: 1
-    CtrlSum: 100.00
-    InitgPty:
-      Nm: Initiating Party Name
-      Id:
-        OrgId:
-          Othr:
-            - Id: 123456789
-              SchmeNm:
-                Cd: BIC
-    FwdgAgt:
-      FinInstnId:
-        BICFI: BICFID0
-    Dbtr:
-      Nm: Debtor Name
-      PstlAdr:
-        AdrLine:
-          - Debtor Address Line 1
-          - Debtor Address Line 2
-      Id:
-        OrgId:
-          Othr:
-            - Id: 123456789
-              SchmeNm:
-                Cd: BIC
-    DbtrAcct:
-      Id:
-        IBAN: BE71096123456769
-    DbtrAgt:
-      FinInstnId:
-        BICFI: BICFID0
-    Cdtr:
-      Nm: Creditor Name
-      PstlAdr:
-        AdrLine:
-          - Creditor Address Line 1
-          - Creditor Address Line 2
-      Id:
-        OrgId:
-          Othr:
-            - Id: 123456789
-              SchmeNm:
-                Cd: BIC
-    CdtrAcct:
-      Id:
-        IBAN: BE71096123456769
-    CdtrAgt:
-      FinInstnId:
-        BICFI: BICFID0
+    TtlIntrBkSttlmAmt:
+      Ccy: EUR
+      Value: 100.0
+    SttlmInf:
+      SttlmMtd: INDA
+      SttlmAcct:
+        Id:
+          IBAN: BE71096123456769
+        Ccy: EUR
+      SttlmAcctOwnr:
+        Nm: Name
+      SttlmAcctSvcr:
+        Nm: Name
+      SttlmAgt:
+        FinInstnId:
+          BICFI: BIC
+    PmtTpInf:
+      InstrPrty: NORM
+      CtgyPurp: CASH
     CdtTrfTxInf:
-      - PmtId:
-          InstrId: 123456789
-          EndToEndId: 123456789
-        Amt:
-          InstdAmt:
-            Ccy: EUR
-            Amt: 100.00
-        CdtrAgt:
+      PmtId:
+        InstrId: 12345
+        EndToEndId: 12345
+      Amt:
+        InstdAmt:
+          Ccy: EUR
+          Value: 100.0
+      Cdtr:
+        Nm: Name
+      CdtrAcct:
+        Id:
+          IBAN: BE71096123456769
+        Ccy: EUR
+      CdtrAgt:
+        FinInstnId:
+          BICFI: BIC
+      Dbtr:
+        Nm: Name
+      DbtrAcct:
+        Id:
+          IBAN: BE71096123456769
+        Ccy: EUR
+      DbtrAgt:
+        FinInstnId:
+          BICFI: BIC
+      IntrBkSttlmAmt:
+        Ccy: EUR
+        Value: 100.0
+      PmtTpInf:
+        InstrPrty: NORM
+        ClrChanl: RTGS
+        SvcLvl:
+          Cd: SEPA
+        LclInstrm:
+          Cd: CORE
+        CtgyPurp:
+          Cd: CASH
+      RgltryRptg:
+        Dbtr:
+          Nm: Name
+        DbtrAcct:
+          Id:
+            IBAN: BE71096123456769
+          Ccy: EUR
+        DbtrAgt:
           FinInstnId:
-            BICFI: BICFID0
+            BICFI: BIC
         Cdtr:
-          Nm: Creditor Name
-          PstlAdr:
-            AdrLine:
-              - Creditor Address Line 1
-              - Creditor Address Line 2
-          Id:
-            OrgId:
-              Othr:
-                - Id: 123456789
-                  SchmeNm:
-                    Cd: BIC
+          Nm: Name

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

@@ -2,8 +2,16 @@ title: FxResponse_FICreditTransferConfirmation
 type: object
 properties:
   GrpHdr:
+    description: >
+      GroupHeader
+
+      Set of characteristics shared by all individual transactions included in the message.
     $ref: ./GroupHeader113.yaml
   CdtTrfTxInf:
+    description: >
+      CreditTransferTransactionInformation
+
+      Set of elements providing information specific to the individual credit transfer(s).
     $ref: ./CreditTransferTransaction68.yaml
 required:
   - GrpHdr

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

@@ -2,8 +2,16 @@ title: Fxecute_FinancialInstitutionCreditTransferV12
 type: object
 properties:
   GrpHdr:
+    description: >
+      GroupHeader.
+
+      Set of characteristics shared by all individual transactions included in the message.
     $ref: ./GroupHeader129.yaml
   CdtTrfTxInf:
+    description: >
+      CreditTransferTransactionInformation.
+
+      Set of elements providing information specific to the individual credit transfer(s).
     $ref: ./CreditTransferTransaction68.yaml
 required:
   - GrpHdr
@@ -11,7 +19,7 @@ required:
 example:
   GrpHdr:
     MsgId: 20191113001
-    CreDtTm: 2019-11-13T10:00:00
+    CreDtTm: '2019-11-13T10:00:00'
     NbOfTxs: 1
     CtrlSum: 1000
     InitgPty:

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

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

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

@@ -2,10 +2,22 @@ title: GenericFinancialIdentification1
 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: ./FinancialIdentificationSchemeName1Choice.yaml
   Issr:
+    description: >
+      Issuer
+
+      Entity that assigns the identification.
     $ref: ./Max35Text.yaml
 required:
   - Id

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

@@ -2,8 +2,17 @@ title: GenericIdentification3
 type: object
 properties:
   Id:
+    description: >
+      Identification
+
+      Name or number assigned by an entity to enable recognition of that entity, for example,
+      account identifier.
     $ref: ./Max35Text.yaml
   Issr:
+    description: >
+      Issuer
+
+      Entity that assigns the identification.
     $ref: ./Max35Text.yaml
 required:
   - Id

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

@@ -2,10 +2,22 @@ title: GenericIdentification30
 type: object
 properties:
   Id:
+    description: >
+      Identification
+
+      Proprietary information, often a code, issued by the data source scheme issuer
     $ref: ./Exact4AlphaNumericText.yaml
   Issr:
+    description: >
+      Issuer
+
+      Entity that assigns the identification.
     $ref: ./Max35Text.yaml
   SchmeNm:
+    description: >
+      SchemeName
+
+      Short textual description of the scheme.
     $ref: ./Max35Text.yaml
 required:
   - Id

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: