@mojaloop/api-snippets 17.6.0-snapshot.0 → 17.6.0

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

@@ -0,0 +1,35 @@
+title: PacsError_FIToFIPaymentStatusReportV15
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader120.yaml
+  TxInfAndSts:
+    $ref: ./PaymentTransaction163.yaml
+  SplmtryData:
+    $ref: ./SupplementaryData1.yaml
+required:
+  - GrpHdr
+example:
+  GrpHdr:
+    MsgId: 12345
+    CreDtTm: '2020-01-01T00:00:00Z'
+    NbOfTxs: 1
+    SttlmInf:
+      SttlmMtd: INDA
+      SttlmDt: '2020-01-01'
+    InstgAgt:
+      FinInstnId:
+        BICFI: BICFI
+    InstdAgt:
+      FinInstnId:
+        BICFI: BICFI
+  TxInfAndSts:
+    OrgnlInstrId: 12345
+    OrgnlEndToEndId: 12345
+    TxSts: RJCT
+    StsRsnInf:
+      Rsn: RSN
+      AddtlInf: ADDITIONAL
+  SplmtryData:
+    PlcAndNm: PLACE
+    Envlp: ENVELOPE

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

@@ -0,0 +1,79 @@
+title: PacsStatus_FIToFIPaymentStatusReportV15
+description: |
+  Unsure on description.
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader120.yaml
+required:
+  - GrpHdr
+example:
+  GrpHdr:
+    MsgId: 123
+    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
+      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

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

@@ -0,0 +1,21 @@
+title: Party38Choice
+description: |
+  Nature or use of the account.
+type: object
+properties:
+  OrgId:
+    $ref: ./OrganisationIdentification29.yaml
+  PrvtId:
+    $ref: ./PersonIdentification13.yaml
+oneOf:
+  - required:
+      - OrgId
+  - required:
+      - PrvtId
+example:
+  OrgId:
+    AnyBIC: BIC
+  PrvtId:
+    DtAndPlcOfBirth:
+      Dt: '2018-01-01'
+      CityOfBirth: City

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

@@ -0,0 +1,37 @@
+title: Party40Choice
+description: |
+  Nature or use of the account.
+type: object
+properties:
+  Pty:
+    $ref: ./PartyIdentification135.yaml
+  Agt:
+    $ref: ./BranchAndFinancialInstitutionIdentification6.yaml
+oneOf:
+  - required:
+      - Pty
+  - required:
+      - Agt
+example:
+  Pty:
+    Nm: Name
+    PstlAdr:
+      Ctry: US
+      AdrLine:
+        - Line1
+        - Line2
+    Id:
+      OrgId:
+        AnyBIC: BIC
+  Agt:
+    FinInstnId:
+      BICFI: BUKBGB22
+    BrnchId:
+      Id: 12345
+      Nm: Oxford Street Branch
+      PstlAdr:
+        Ctry: GB
+        AdrLine:
+          - 1 Oxford Street
+          - London
+          - UK

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

@@ -0,0 +1,21 @@
+title: Party52Choice
+description: |
+  Nature or use of the account.
+type: object
+properties:
+  OrgId:
+    $ref: ./OrganisationIdentification39.yaml
+  PrvtId:
+    $ref: ./PersonIdentification18.yaml
+oneOf:
+  - required:
+      - OrgId
+  - required:
+      - PrvtId
+example:
+  OrgId:
+    AnyBIC: BIC
+  PrvtId:
+    DtAndPlcOfBirth:
+      Dt: '2018-01-01'
+      CityOfBirth: City

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

@@ -0,0 +1,34 @@
+title: PartyIdentification135
+description: |
+  Specifies the identification of a person or an organisation.
+type: object
+properties:
+  Nm:
+    $ref: ./Max140Text.yaml
+  PstlAdr:
+    $ref: ./PostalAddress24.yaml
+  Id:
+    $ref: ./Party38Choice.yaml
+  CtryOfRes:
+    $ref: ./CountryCode.yaml
+  CtctDtls:
+    $ref: ./Contact4.yaml
+example:
+  Nm: John Doe
+  PstlAdr:
+    Ctry: BE
+    AdrLine:
+      - Rue du Marché 45
+      - Brussels
+      - BE
+  Id:
+    OrgId:
+      AnyBIC: CCCCUS33
+  CtryOfRes: BE
+  CtctDtls:
+    NmPrfx: Mr
+    Nm: John Doe
+    PhneNb: +123-123-321
+    MobNb: +123-123-321
+    FaxNb: +123-123-321
+    EmailAdr:

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

@@ -0,0 +1,42 @@
+title: PartyIdentification272
+description: |
+  Specifies the identification of a person or an organisation.
+type: object
+properties:
+  Nm:
+    $ref: ./Max140Text.yaml
+  PstlAdr:
+    $ref: ./PostalAddress27.yaml
+  Id:
+    $ref: ./Party52Choice.yaml
+  CtryOfRes:
+    $ref: ./CountryCode.yaml
+  CtctDtls:
+    $ref: ./Contact13.yaml
+example:
+  Nm: John Doe
+  PstlAdr:
+    AdrTp: ADDR
+    Dept: Dept
+    SubDept: SubDept
+    StrtNm: StrtNm
+    BldgNb: BldgNb
+    PstCd: PstCd
+    TwnNm: TwnNm
+    CtrySubDvsn: CtrySubDvsn
+    Ctry: Ctry
+  Id:
+    OrgId:
+      AnyBIC: BIC
+    PrvtId:
+      DtAndPlcOfBirth:
+        Dt: '2018-01-01'
+        CityOfBirth: City
+  CtryOfRes: BE
+  CtctDtls:
+    NmPrfx: Mr
+    Nm: John Doe
+    PhneNb: +123-123-321
+    MobNb: +123-123-321
+    FaxNb: +123-123-321
+    EmailAdr:

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

@@ -0,0 +1,23 @@
+title: PaymentIdentification13
+description: |
+  Provides further means of referencing a payment transaction.
+type: object
+properties:
+  InstrId:
+    $ref: ./Max35Text.yaml
+  EndToEndId:
+    $ref: ./Max35Text.yaml
+  TxId:
+    $ref: ./Max35Text.yaml
+  UETR:
+    $ref: ./UUIDv4Identifier.yaml
+  ClrSysRef:
+    $ref: ./Max35Text.yaml
+required:
+  - EndToEndId
+example:
+  InstrId: INSTRUCTIONID
+  EndToEndId: ENDTOENDID
+  TxId: TRANSACTIONID
+  UETR: 123e4567-e89b-12d3-a456-426614174000
+  ClrSysRef: CLRSYSREF

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

@@ -0,0 +1,47 @@
+title: PaymentTransaction163
+description: >
+  Provides further details on the original transactions, to which the status
+  report message refers.
+type: object
+properties:
+  StsId:
+    $ref: ./Max35Text.yaml
+  OrgnlInstrId:
+    $ref: ./Max35Text.yaml
+  OrgnlEndToEndId:
+    $ref: ./Max35Text.yaml
+  OrgnlTxId:
+    $ref: ./Max35Text.yaml
+  OrgnlUETR:
+    $ref: ./UUIDv4Identifier.yaml
+  TxSts:
+    $ref: ./ExternalPaymentTransactionStatus1Code.yaml
+  StsRsnInf:
+    $ref: ./StatusReasonInformation14.yaml
+  AccptncDtTm:
+    $ref: ./ISODateTime.yaml
+  AcctSvcrRef:
+    $ref: ./Max35Text.yaml
+  ClrSysRef:
+    $ref: ./Max35Text.yaml
+  ExctnConf:
+    $ref: ./Exact32HexBinaryText.yaml
+  SplmtryData:
+    $ref: ./SupplementaryData1.yaml
+example:
+  StsId: 12345
+  OrgnlInstrId: 12345
+  OrgnlEndToEndId: 12345
+  OrgnlTxId: 12345
+  OrgnlUETR: 123e4567-e89b-12d3-a456-426614174000
+  TxSts: RJCT
+  StsRsnInf:
+    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/PaymentTypeInformation28.yaml

@@ -0,0 +1,24 @@
+title: PaymentTypeInformation28
+description: |
+  Provides further details of the type of payment.
+type: object
+properties:
+  InstrPrty:
+    $ref: ./Priority2Code.yaml
+  ClrChanl:
+    $ref: ./ClearingChannel2Code.yaml
+  SvcLvl:
+    $ref: ./ServiceLevel8Choice.yaml
+  LclInstrm:
+    $ref: ./LocalInstrument2Choice.yaml
+  CtgyPurp:
+    $ref: ./CategoryPurpose1Choice.yaml
+example:
+  InstrPrty: NORM
+  ClrChanl: RTGS
+  SvcLvl:
+    Cd: SEPA
+  LclInstrm:
+    Cd: CORE
+  CtgyPurp:
+    Cd: CASH

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

@@ -0,0 +1,4 @@
+title: PercentageRate
+type: string
+pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$
+example: 1234

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

@@ -0,0 +1,18 @@
+title: PersonIdentification13
+description: |
+  Unique and unambiguous way to identify a person.
+type: object
+properties:
+  DtAndPlcOfBirth:
+    $ref: ./DateAndPlaceOfBirth1.yaml
+  Othr:
+    $ref: ./GenericPersonIdentification1.yaml
+example:
+  DtAndPlcOfBirth:
+    Dt: '2018-01-01'
+    CityOfBirth: City
+  Othr:
+    Id: 123
+    SchmeNm:
+      Cd: CUST
+      Prtry: 1

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

@@ -0,0 +1,18 @@
+title: PersonIdentification18
+description: |
+  Unique and unambiguous way to identify a person.
+type: object
+properties:
+  DtAndPlcOfBirth:
+    $ref: ./DateAndPlaceOfBirth1.yaml
+  Othr:
+    $ref: ./GenericPersonIdentification2.yaml
+example:
+  DtAndPlcOfBirth:
+    Dt: '2018-01-01'
+    CityOfBirth: City
+  Othr:
+    Id: 123
+    SchmeNm:
+      Cd: CUST
+      Prtry: 1

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

@@ -0,0 +1,16 @@
+title: PersonIdentificationSchemeName1Choice
+description: |
+  Sets of elements to identify a name of the identification scheme.
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalPersonIdentification1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CCPT

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

@@ -0,0 +1,5 @@
+title: PhoneNumber
+type: string
+description: |
+  Double check this regex.
+pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$

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

@@ -0,0 +1,55 @@
+title: PostalAddress24
+type: object
+description: >
+  Information that locates and identifies a specific address, as defined by
+  postal services.
+properties:
+  AdrTp:
+    $ref: ./AddressType3Choice.yaml
+  Dept:
+    $ref: ./Max70Text.yaml
+  SubDept:
+    $ref: ./Max70Text.yaml
+  StrtNm:
+    $ref: ./Max70Text.yaml
+  BldgNb:
+    $ref: ./Max16Text.yaml
+  BldgNm:
+    $ref: ./Max35Text.yaml
+  Flr:
+    $ref: ./Max70Text.yaml
+  PstBx:
+    $ref: ./Max16Text.yaml
+  Room:
+    $ref: ./Max70Text.yaml
+  PstCd:
+    $ref: ./Max16Text.yaml
+  TwnNm:
+    $ref: ./Max35Text.yaml
+  TwnLctnNm:
+    $ref: ./Max35Text.yaml
+  DstrctNm:
+    $ref: ./Max35Text.yaml
+  CtrySubDvsn:
+    $ref: ./Max35Text.yaml
+  Ctry:
+    $ref: ./CountryCode.yaml
+  AdrLine:
+    $ref: ./Max70Text.yaml
+example:
+  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

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

@@ -0,0 +1,61 @@
+title: PostalAddress27
+type: object
+description: >
+  Information that locates and identifies a specific address, as defined by
+  postal services.
+properties:
+  AdrTp:
+    $ref: ./AddressType3Choice.yaml
+  CareOf:
+    $ref: ./Max140Text.yaml
+  Dept:
+    $ref: ./Max70Text.yaml
+  SubDept:
+    $ref: ./Max70Text.yaml
+  StrtNm:
+    $ref: ./Max140Text.yaml
+  BldgNb:
+    $ref: ./Max16Text.yaml
+  BldgNm:
+    $ref: ./Max140Text.yaml
+  Flr:
+    $ref: ./Max70Text.yaml
+  UnitNb:
+    $ref: ./Max16Text.yaml
+  PstBx:
+    $ref: ./Max16Text.yaml
+  Room:
+    $ref: ./Max70Text.yaml
+  PstCd:
+    $ref: ./Max16Text.yaml
+  TwnNm:
+    $ref: ./Max140Text.yaml
+  TwnLctnNm:
+    $ref: ./Max140Text.yaml
+  DstrctNm:
+    $ref: ./Max140Text.yaml
+  CtrySubDvsn:
+    $ref: ./Max35Text.yaml
+  Ctry:
+    $ref: ./CountryCode.yaml
+  AdrLine:
+    $ref: ./Max70Text.yaml
+example:
+  AdrTp: ADDR
+  CareOf: CareOf
+  Dept: Dept
+  SubDept: SubDept
+  StrtNm: StrtNm
+  BldgNb: BldgNb
+  BldgNm: BldgNm
+  Flr: Flr
+  UnitNb: UnitNb
+  PstBx: PstBx
+  Room: Room
+  PstCd: PstCd
+  TwnNm: TwnNm
+  TwnLctnNm: TwnLctnNm
+  DstrctNm: DstrctNm
+  CtrySubDvsn: CtrySubDvsn
+  Ctry: Ctry
+  AdrLine: AdrLine

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

@@ -0,0 +1,11 @@
+title: PreferredContactMethod1Code
+description: |
+  Preferred method used to reach the individual contact within an organisation.
+type: string
+enum:
+  - LETT
+  - MAIL
+  - PHON
+  - FAXX
+  - CELL
+example: CELL

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

@@ -0,0 +1,11 @@
+title: PreferredContactMethod2Code
+description: |
+  Preferred method used to reach the individual contact within an organisation.
+type: string
+enum:
+  - LETT
+  - MAIL
+  - PHON
+  - FAXX
+  - CELL
+example: MAIL

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

@@ -0,0 +1,9 @@
+title: Priority2Code
+description: >
+  Indicator of the urgency or order of importance that the instructing party
+  would like the instructed party to apply to the processing of the instruction.
+type: string
+enum:
+  - HIGH
+  - NORM
+example: HIGH

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

@@ -0,0 +1,15 @@
+title: ProxyAccountIdentification1
+description: |
+  Information related to a proxy identification of the account.
+type: object
+properties:
+  Tp:
+    $ref: ./ProxyAccountType1Choice.yaml
+  Id:
+    $ref: ./Max2048Text.yaml
+required:
+  - Id
+example:
+  Tp:
+    Cd: IBAN
+  Id: 123

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

@@ -0,0 +1,16 @@
+title: ProxyAccountType1Choice
+type: object
+description: |
+  NOTE: Unsure on description.
+properties:
+  Cd:
+    $ref: ./ExternalProxyAccountType1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CH03

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

@@ -0,0 +1,21 @@
+title: Purpose2Choice
+description: >
+  Specifies the underlying reason for the payment transaction.
+
+  Usage: Purpose is used by the end-customers, that is initiating party,
+  (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose
+  is a content element, which is not used for processing by any of the agents involved in the payment
+  chain.
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalPurpose1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CH03

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

@@ -0,0 +1,12 @@
+title: RegulatoryAuthority2
+description: |
+  Information about an entity requiring the regulatory reporting information.
+type: object
+properties:
+  Nm:
+    $ref: ./Max140Text.yaml
+  Ctry:
+    $ref: ./CountryCode.yaml
+example:
+  Nm: Swiss National Bank
+  Ctry: CH

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

@@ -0,0 +1,19 @@
+title: RegulatoryReporting3
+description: |
+  Information needed due to regulatory and/or statutory requirements.
+type: object
+properties:
+  DbtCdtRptgInd:
+    $ref: ./RegulatoryReportingType1Code.yaml
+  Authrty:
+    $ref: ./RegulatoryAuthority2.yaml
+  Dtls:
+    $ref: ./StructuredRegulatoryReporting3.yaml
+example:
+  DbtCdtRptgInd: CRED
+  Authrty:
+    Nm: Swiss National Bank
+    Ctry: CH
+  Dtls:
+    Cd: A1
+    Inf: Mandatory regulatory information

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

@@ -0,0 +1,10 @@
+title: RegulatoryReportingType1Code
+description: >
+  Identifies whether the regulatory reporting information applies to the debit
+  side, to the credit side or to both debit and credit sides of the transaction.
+type: string
+enum:
+  - CRED
+  - DEBT
+  - BOTH
+example: BOTH