@mojaloop/api-snippets 17.6.0-snapshot.2 → 17.6.1

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

@@ -0,0 +1,5 @@
+title: ExternalVerificationReason1Code
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

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

@@ -0,0 +1,22 @@
+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:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: BIC

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

@@ -0,0 +1,65 @@
+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: J5BMVH7D
+  ClrSysMmbId:
+    ClrSysId: 1234
+    MmbId: 123
+  LEI: 123
+  Nm: Name
+  PstlAdr:
+    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

@@ -0,0 +1,65 @@
+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: J5BMVH7D
+  ClrSysMmbId:
+    ClrSysId:
+      Cd: CHQB
+    MmbId: 123456789
+  LEI: 123
+  Nm: Name
+  PstlAdr:
+    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

@@ -0,0 +1,85 @@
+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: 12345
+    CreDtTm: '2020-01-01T00:00:00Z'
+    NbOfTxs: 1
+    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: 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: BIC
+        Cdtr:
+          Nm: Name

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

@@ -0,0 +1,89 @@
+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
+  - CdtTrfTxInf
+example:
+  GrpHdr:
+    MsgId: 20191122-123456
+    CreDtTm: '2019-11-22T12:34:56'
+    NbOfTxs: 1
+    CtrlSum: 100.00
+    InitgPty:
+      Nm: Initiating Party Name
+    MsgRcpt:
+      Nm: Message Recipient Name
+  CdtTrfTxInf:
+    PmtId:
+      InstrId: 20191122-123456
+      EndToEndId: 20191122-123456
+    PmtTpInf:
+      InstrPrty: NORM
+      CtgyPurp: SUPP
+    IntrBkSttlmAmt:
+      Amt: 100.00
+      Ccy: EUR
+    ChrgBr: SLEV
+    Cdtr:
+      Nm: Creditor Name
+    CdtrAcct:
+      Id:
+        IBAN: BE71096123456769
+      Tp:
+        Cd: CACC
+      Ccy: EUR
+      Nm: My account
+    CdtrAgt:
+      FinInstnId:
+        BICFI: BNBABEBB
+    CdtrAgtAcct:
+      Id:
+        IBAN: BE71096123456769
+      Tp:
+        Cd: CACC
+      Ccy: EUR
+      Nm: My account
+    Dbtr:
+      Nm: Debtor Name
+    DbtrAcct:
+      Id:
+        IBAN: BE71096123456769
+      Tp:
+        Cd: CACC
+      Ccy: EUR
+      Nm: My account
+    DbtrAgt:
+      FinInstnId:
+        BICFI: BNBABEBB
+    DbtrAgtAcct:
+      Id:
+        IBAN: BE71096123456769
+      Tp:
+        Cd: CACC
+      Ccy: EUR
+      Nm: My account
+    RmtInf:
+      Ustrd: Remittance Information
+    RgltryRptg:
+      Dbtr:
+        Nm: Debtor Name
+      DbtrAcct:
+        Id:
+          IBAN: BE71096123456769
+        Tp:
+          Cd: CACC
+        Ccy: EUR
+        Nm: My account

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

@@ -0,0 +1,65 @@
+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
+  - CdtTrfTxInf
+example:
+  GrpHdr:
+    MsgId: 20191113001
+    CreDtTm: '2019-11-13T10:00:00'
+    NbOfTxs: 1
+    CtrlSum: 1000
+    InitgPty:
+      Nm: Initiating Party Name
+      Id:
+        OrgId:
+          Othr:
+            Id: 123456789
+            SchmeNm:
+              Cd: BBA
+    FwdgAgt:
+      FinInstnId:
+        BICFI: BBBBBBBB
+    DbtrAgt:
+      FinInstnId:
+        BICFI: AAAAAAAA
+    CdtrAgt:
+      FinInstnId:
+        BICFI: CCCCCCCC
+  CdtTrfTxInf:
+    PmtId:
+      InstrId: 20191113001
+      EndToEndId: 20191113001
+    PmtTpInf:
+      InstrPrty: NORM
+      CtgyPurp:
+        Cd: SUPP
+    InstrForCdtrAgt:
+      Cd: /ACC/123456789
+    IntrBkSttlmAmt:
+      Amt: 1000
+      Ccy: EUR
+    ChrgBr: SLEV
+    CdtrAgt:
+      FinInstnId:
+        BICFI: CCCCCCCC
+    Cdtr:
+      Nm: Creditor Name
+    CdtrAcct:
+      Id:
+        IBAN: BE71096123456769
+    RmtInf:
+      Ustrd: Payment for invoice 12345

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

@@ -0,0 +1,28 @@
+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
+example:
+  Id: 123
+  SchmeNm:
+    Cd: IBAN
+  Issr: BIC

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

@@ -0,0 +1,28 @@
+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
+example:
+  Id: 123
+  SchmeNm:
+    Cd: IBAN
+  Issr: BIC

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

@@ -0,0 +1,21 @@
+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
+example:
+  Id: 123
+  Issr: BIC

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

@@ -0,0 +1,28 @@
+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
+  - Issr
+example:
+  Id: 1234
+  Issr: BIC
+  SchmeNm: BICFI

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

@@ -0,0 +1,28 @@
+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
+example:
+  Id: 123
+  SchmeNm:
+    Cd: BIC
+  Issr: BIC

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

@@ -0,0 +1,28 @@
+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
+example:
+  Id: 123
+  SchmeNm:
+    Cd: BIC
+  Issr: BIC

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

@@ -0,0 +1,28 @@
+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
+example:
+  Id: 123
+  SchmeNm:
+    Cd: DRLC
+  Issr: BIC

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

@@ -0,0 +1,28 @@
+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
+example:
+  Id: 123
+  SchmeNm:
+    Cd: DRLC
+  Issr: BIC

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

@@ -0,0 +1,70 @@
+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
+  - Rpt
+example:
+  Assgnmt:
+    Id: 123
+    CreDtTm: '2013-03-07T16:30:00'
+    Assgnr:
+      Id:
+        Id: 123
+        SchmeNm:
+          Cd: IBAN
+        Issr: BIC
+    Assgne:
+      Id:
+        Id: 123
+        SchmeNm:
+          Cd: IBAN
+        Issr: BIC
+  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