@mojaloop/api-snippets 17.6.0 → 17.6.1

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

@@ -5,28 +5,76 @@ description: >
 type: object
 properties:
   PmtId:
+    description: >
+      PaymentIdentification
+
+      Set of elements used to reference a payment instruction.
     $ref: ./PaymentIdentification13.yaml
   PmtTpInf:
+    description: >
+      PaymentTypeInformation
+
+       Set of elements used to further specify the type of transaction.
     $ref: ./PaymentTypeInformation28.yaml
   IntrBkSttlmAmt:
+    description: >
+      InterbankSettlementAmount
+
+      Amount of money moved between the instructing agent and the instructed agent.
     $ref: ./ActiveCurrencyAndAmount.yaml
   Dbtr:
+    description: >
+      Debtor
+
+      Party that owes an amount of money to the (ultimate) creditor.
     $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
   DbtrAcct:
+    description: >
+      DebtorAccount
+
+      Account used to process a payment.
     $ref: ./CashAccount40.yaml
   DbtrAgt:
+    description: >
+      DebtorAgent
+
+      Financial institution servicing an account for the debtor.
     $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
   CdtrAgt:
+    description: >
+      CreditorAgent
+
+      Financial institution servicing an account for the creditor.
     $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
   Cdtr:
+    description: >
+      Creditor
+
+      Party to which an amount of money is due.
     $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
   CdtrAcct:
+    description: >
+      CreditorAccount
+
+      Account to which a credit entry is made.
     $ref: ./CashAccount40.yaml
   InstrForCdtrAgt:
+    description: >
+      InstructionForCreditorAgent
+
+      Set of elements used to provide information on the remittance advice.
     $ref: ./InstructionForCreditorAgent3.yaml
   Purp:
+    description: >
+      Purpose
+
+      Underlying reason for the payment transaction.
     $ref: ./Purpose2Choice.yaml
   VrfctnOfTerms:
+    description: >
+      VerificationOfTerms
+
+      Set of elements used to provide information on the underlying terms of the transaction.
     $ref: ./CryptographicLockChoice.yaml
 required:
   - PmtId

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

@@ -4,12 +4,28 @@ description: |
 type: object
 properties:
   BirthDt:
+    description: >
+      BirthDate
+
+      Date on which a person is born.
     $ref: ./ISODate.yaml
   PrvcOfBirth:
+    description: >
+      ProvinceOfBirth
+
+      Province where a person was born.
     $ref: ./Max35Text.yaml
   CityOfBirth:
+    description: >
+      CityOfBirth
+
+      City where a person was born.
     $ref: ./Max35Text.yaml
   CtryOfBirth:
+    description: >
+      CountryOfBirth
+
+      Country where a person was born.
     $ref: ./CountryCode.yaml
 required:
   - BirthDt

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

@@ -4,12 +4,20 @@ description: |
 type: object
 properties:
   FrDt:
+    description: >
+      FromDate
+
+      Start date of the range.
     $ref: ./ISODate.yaml
   ToDt:
+    description: >
+      ToDate
+
+      End date of the range.
     $ref: ./ISODate.yaml
 required:
   - FrDt
   - ToDt
 example:
-  FrDt: 2020-01-01
-  ToDt: 2020-12-31
+  FrDt: '2022-01-01T00:00:00.000Z'
+  ToDt: '2022-12-31T23:59:59.999Z'

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

@@ -2,60 +2,68 @@ title: Execute_FIToFICustomerCreditTransferV13
 type: object
 properties:
   GrpHdr:
+    description: >
+      GroupHeader.
     $ref: ./GroupHeader129.yaml
   CdtTrfTxInf:
+    description: >
+      CreditTransferTransactionInformation.
     $ref: ./CreditTransferTransaction67.yaml
 required:
   - GrpHdr
   - CdtTrfTxInf
 example:
   GrpHdr:
-    MsgId: 123456789
-    CreDtTm: 2020-01-01T00:00:00Z
+    MsgId: 12345
+    CreDtTm: '2020-01-01T00:00:00Z'
+    PmtInstrXpryDtTm: '2020-01-01T00:00:00Z'
     NbOfTxs: 1
-    CtrlSum: 100.00
-    InitgPty:
-      Nm: Initiating Party Name
-      Id:
-        OrgId:
-          Othr:
-            - Id: 123456789
-              SchmeNm:
-                Cd: 91
-    FwdgAgt:
-      FinInstnId:
-        BICFI: BBBBBBBB
+    SttlmInf:
+      SttlmMtd: INDA
+      SttlmAcct:
+        Id:
+          IBAN: 123
+      SttlmAcctOwnr:
+        Nm: John Doe
+      SttlmAcctSvcr:
+        BICFI: 123
+    CdtTrfTxInf:
+      PmtId:
+        InstrId: 123
+        EndToEndId: 123
+      PmtTpInf:
+        InstrPrty: NORM
+      InstdAmt:
+        Amt: 123
+        Ccy: EUR
+      ChrgBr: SLEV
+      CdtrAgt:
+        FinInstnId:
+          BICFI: 123
+      Cdtr:
+        Nm: John Doe
+      CdtrAcct:
+        Id:
+          IBAN: 123
+      RmtInf:
+        Ustrd: Test
   CdtTrfTxInf:
     PmtId:
-      InstrId: 123456789
-      EndToEndId: 123456789
+      InstrId: 123
+      EndToEndId: 123
     PmtTpInf:
       InstrPrty: NORM
-      CtgyPurp:
-        Cd: SUPP
-    InstrForCdtrAgt:
-      FinInstnId:
-        BICFI: AAAAAAAA
+    InstdAmt:
+      Amt: 123
+      Ccy: EUR
+    ChrgBr: SLEV
     CdtrAgt:
       FinInstnId:
-        BICFI: AAAAAAAA
+        BICFI: 123
     Cdtr:
-      Nm: Creditor Name
-      PstlAdr:
-        AdrLine:
-          - Creditor Address Line 1
-          - Creditor Address Line 2
-          - Creditor Address Line 3
-          - Creditor Address Line 4
-          - Creditor Address Line 5
-      Id:
-        OrgId:
-          Othr:
-            - Id: 123456789
-              SchmeNm:
-                Cd: 91
+      Nm: John Doe
     CdtrAcct:
       Id:
-        IBAN: DE87123456781234567890
+        IBAN: 123
     RmtInf:
-      Ustrd: Remittance Information
+      Ustrd: Test

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

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

@@ -2,23 +2,64 @@ title: FinancialInstitutionIdentification18
 type: object
 properties:
   BICFI:
+    description: >
+      BICFI
+
+      Code allocated to a financial institution by the ISO 9362 Registration Authority as described
+      in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
     $ref: ./BICFIDec2014Identifier.yaml
   ClrSysMmbId:
+    description: >
+      ClearingSystemMemberIdentification
+
+      Information used to identify a member within a clearing system
     $ref: ./ClearingSystemMemberIdentification2.yaml
   LEI:
+    description: >
+      LEI
+
+      Legal entity identifier 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: ./PostalAddress24.yaml
   Othr:
+    description: >
+      Other
+
+      Unique identification of an agent, as assigned by an institution, using an identification
+      scheme.
     $ref: ./GenericFinancialIdentification1.yaml
 example:
-  BICFI: BUKBGB22
-  Nm: Barclays Bank Plc
+  BICFI: J5BMVH7D
+  ClrSysMmbId:
+    ClrSysId: 1234
+    MmbId: 123
+  LEI: 123
+  Nm: Name
   PstlAdr:
-    Ctry: GB
-    AdrLine:
-      - 1 Churchill Place
-      - 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
+  Othr:
+    Id: 123
+    SchmeNm:
+      Cd: 123
+      Prtry: 123
+    Issr: 123

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

@@ -2,23 +2,64 @@ title: FinancialInstitutionIdentification23
 type: object
 properties:
   BICFI:
+    description: >
+      BICFI
+
+      Code allocated to a financial institution by the ISO 9362 Registration Authority as described
+      in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)"
     $ref: ./BICFIDec2014Identifier.yaml
   ClrSysMmbId:
+    description: >
+      ClearingSystemMemberIdentification
+
+      Information used to identify a member within a clearing system
     $ref: ./ClearingSystemMemberIdentification2.yaml
   LEI:
+    description: >
+      LEI
+
+      Legal entity identifier 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
   Othr:
+    description: >
+      Other
+
+      Unique identification of an agent, as assigned by an institution, using an identification
+      scheme.
     $ref: ./GenericFinancialIdentification1.yaml
 example:
-  BICFI: BUKBGB22
-  Nm: Barclays Bank Plc
+  BICFI: J5BMVH7D
+  ClrSysMmbId:
+    ClrSysId:
+      Cd: CHQB
+    MmbId: 123456789
+  LEI: 123
+  Nm: Name
   PstlAdr:
-    Ctry: GB
-    AdrLine:
-      - 1 Churchill Place
-      - 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
+  Othr:
+    Id: 123
+    SchmeNm:
+      Cd: CHQB
+    Issr: 123

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