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

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

@@ -4,28 +4,76 @@ description: |
 type: object
 properties:
   NmPrfx:
+    description: >
+      NamePrefix
+
+      Name prefix to be used before the name of the person.
     $ref: ./NamePrefix2Code.yaml
   Nm:
+    description: >
+      Name
+
+      Name by which a party is known and which is usually used to identify that party.
     $ref: ./Max140Text.yaml
   PhneNb:
+    description: >
+      PhoneNumber
+
+      Collection of information that identifies a phone number, as defined by telecom services.
     $ref: ./PhoneNumber.yaml
   MobNb:
+    description: >
+      MobilePhoneNumber
+
+      Collection of information that identifies a mobile phone number, as defined by telecom services.
     $ref: ./PhoneNumber.yaml
   FaxNb:
+    description: >
+      FaxNumber
+
+      Collection of information that identifies a fax number, as defined by telecom services.
     $ref: ./PhoneNumber.yaml
   EmailAdr:
+    description: >
+      EmailAddress
+
+      Address for electronic mail (e-mail).
     $ref: ./Max2048Text.yaml
   EmailPurp:
+    description: >
+      EmailPurpose
+
+      Purpose for which an email address may be used.
     $ref: ./Max35Text.yaml
   JobTitl:
+    description: >
+      JobTitle
+
+      Title of the function.
     $ref: ./Max35Text.yaml
   Rspnsblty:
+    description: >
+      Responsibility
+
+      Role of a person in an organisation.
     $ref: ./Max35Text.yaml
   Dept:
+    description: >
+      Department
+
+      Identification of a division of a large organisation or building.
     $ref: ./Max70Text.yaml
   Othr:
+    description: >
+      Other
+
+      : Contact details in another form.
     $ref: ./OtherContact1.yaml
   PrefrdMtd:
+    description: >
+      PreferredMethod
+
+      Preferred method used to reach the contact.
     $ref: ./PreferredContactMethod1Code.yaml
 example:
   NmPrfx: Mr

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

@@ -2,3 +2,6 @@ title: CountryCode
 type: string
 pattern: ^[A-Z]{2,2}$
 example: US
+description: >
+  Code to identify a country, a dependency, or another area of particular geopolitical interest,
+  on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

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

@@ -5,40 +5,118 @@ 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
   InstdAmt:
+    description: >
+      InstructedAmount
+
+      Amount of money to be moved between the debtor and creditor,
+      before deduction of charges, expressed in the currency as ordered by the initiating party.
     $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
   XchgRate:
+    description: >
+      ExchangeRate
+
+      Factor used to convert an amount from one currency into another. This reflects the price at
+      which one currency was bought with another currency.
     $ref: ./BaseOneRate.yaml
   ChrgBr:
+    description: >
+      ChargeBearer
+
+      Specifies which party/parties will bear the charges associated with the processing of the
+      payment transaction.
     $ref: ./ChargeBearerType1Code.yaml
   ChrgsInf:
+    description: >
+      ChargesInformation
+
+      Provides information on the charges to be paid by the charge bearer(s) related to the
+      payment transaction
     $ref: ./Charges16.yaml
   Dbtr:
+    description: >
+      Debtor
+
+      Party that owes an amount of money to the (ultimate) creditor.
     $ref: ./PartyIdentification272.yaml
   DbtrAcct:
+    description: >
+      DebtorAccount
+
+      Unambiguous identification of the account of the debtor to which a debit entry will be made
+      as a result of the transaction.
     $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: ./PartyIdentification272.yaml
   CdtrAcct:
+    description: >
+      CreditorAccount
+
+      Unambiguous identification of the account of the creditor to which a credit entry will be
+      posted as a result of the payment transaction.
     $ref: ./CashAccount40.yaml
   InstrForCdtrAgt:
+    description: >
+      InstructionForCreditorAgent
+
+      Set of elements used to provide information on the remittance advice.
     $ref: ./InstructionForCreditorAgent3.yaml
   InstrForNxtAgt:
+    description: >
+      InstructionForNextAgent
+
+      Set of elements used to provide information on the remittance advice.
     $ref: ./InstructionForNextAgent1.yaml
   Purp:
+    description: >
+      Purpose
+
+      Underlying reason for the payment transaction.
     $ref: ./Purpose2Choice.yaml
   RgltryRptg:
+    description: >
+      RegulatoryReporting
+
+      Information needed due to regulatory and statutory requirements.
     $ref: ./RegulatoryReporting3.yaml
   Tax:
+    description: >
+      Tax
+
+      Provides details on the tax.
     $ref: ./TaxData1.yaml
   VrfctnOfTerms:
     $ref: ./CryptographicLockChoice.yaml

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