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

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,23 @@
+title: ProxyAccountIdentification1
+description: |
+  Information related to a proxy identification of the account.
+type: object
+properties:
+  Tp:
+    description: |
+      Type
+
+      Type of the proxy identification.
+    $ref: ./ProxyAccountType1Choice.yaml
+  Id:
+    description: |
+      Identification
+
+      Identification used to indicate the account identification under another specified name.
+    $ref: ./Max2048Text.yaml
+required:
+  - Id
+example:
+  Tp:
+    Cd: IBAN
+  Id: 123

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

@@ -0,0 +1,26 @@
+title: ProxyAccountType1Choice
+type: object
+description: |
+  ProxyAccountType1Choice
+
+  Specifies the scheme used for the identification of an account alias.
+properties:
+  Cd:
+    description: |
+      Code
+
+      Name of the identification scheme, in a coded form as published in an external list.
+    $ref: ./ExternalProxyAccountType1Code.yaml
+  Prtry:
+    description: |
+      Proprietary
+
+      Name of the identification scheme, in a free text form.
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CH03

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

@@ -0,0 +1,29 @@
+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:
+    description: |
+      Code
+
+      Underlying reason for the payment transaction, as published in an external purpose code list.
+    $ref: ./ExternalPurpose1Code.yaml
+  Prtry:
+    description: |
+      Proprietary
+
+      Purpose, in a proprietary form.
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CH03

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

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

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

@@ -0,0 +1,37 @@
+title: RegulatoryReporting3
+description: |
+  Information needed due to regulatory and/or statutory requirements.
+type: object
+properties:
+  DbtCdtRptgInd:
+    description: >
+      DebitCreditReportingIndicator
+
+      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.
+    $ref: ./RegulatoryReportingType1Code.yaml
+  Authrty:
+    description: |
+      Authority
+
+      Entity requiring the regulatory reporting information.
+    $ref: ./RegulatoryAuthority2.yaml
+  Dtls:
+    description: >
+      Details
+
+      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.
+    anyOf:
+      - $ref: ./StructuredRegulatoryReporting3.yaml
+      - items:
+          $ref: ./StructuredRegulatoryReporting3.yaml
+        type: array
+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

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

@@ -0,0 +1,25 @@
+title: ServiceLevel8Choice
+description: |
+  Details about a service level.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Specifies a pre-agreed service or level of service between the parties,
+      as published in an external service level code list.
+    $ref: ./ExternalServiceLevel1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Specifies a pre-agreed service or level of service between the parties, as a proprietary code.
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: SEPA

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

@@ -0,0 +1,47 @@
+title: SettlementInstruction15
+description: |
+  Specifies the details on how the settlement of the original transaction(s) between the
+  instructing agent and the instructed agent was completed.
+type: object
+properties:
+  SttlmMtd:
+    description: >
+      SettlementMethod
+
+      Method used to settle the (batch of) payment instructions.
+    $ref: ./SettlementMethod1Code.yaml
+  PmtTpInf:
+    description: |
+      PaymentTypeInformation
+    $ref: ./PaymentTypeInformation28.yaml
+required:
+  - SttlmMtd
+example:
+  SttlmMtd: INDA
+  PmtTpInf:
+    InstrPrty: NORM
+    SvcLvl:
+      Cd: SEPA
+    LclInstrm:
+      Cd: CH03
+    CtgyPurp:
+      Cd: SUPP
+    Cdtr:
+      Nm: Name
+      PstlAdr:
+        AdrTp: ADDR
+        AdrLine: Address
+        Ctry: CH
+      Id:
+        OrgId:
+          AnyBIC: BIC
+          Othr:
+            Id: 123
+            SchmeNm:
+              Cd: IBAN
+              Issr: BIC
+      CtryOfRes: CH
+      CtctDtls:
+        Nm: Name
+        PhneNb: 123
+        EmailAdr:

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

@@ -0,0 +1,10 @@
+title: SettlementMethod1Code
+description: |
+  Specifies the method used to settle the credit transfer instruction.
+type: string
+enum:
+  - INDA
+  - INGA
+  - COVE
+  - CLRG
+example: CLRG

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

@@ -0,0 +1,24 @@
+title: StatusReason6Choice
+description: |
+  Unsure on description.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Reason for the status, as published in an external reason code list.
+    $ref: ./ExternalStatusReason1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Reason for the status, in a proprietary form.
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: AGNT

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

@@ -0,0 +1,39 @@
+title: StatusReasonInformation14
+description: |
+  Unsure on description.
+type: object
+properties:
+  Orgtr:
+    description:
+      Originator
+
+      Party that issues the status.
+    $ref: ./PartyIdentification272.yaml
+  Rsn:
+    description:
+      Reason
+
+      Specifies the reason for the status report.
+    $ref: ./StatusReason6Choice.yaml
+  AddtlInf:
+    description:
+      AdditionalInformation
+
+      Additional information about the status report.
+    $ref: ./Max105Text.yaml
+example:
+  Orgtr:
+    Nm: Name
+    PstlAdr:
+      AdrTp: ADDR
+      Dept: Department
+      SubDept: SubDepartment
+      StrtNm: StreetName
+      BldgNb: BuildingNumber
+      PstCd: PostCode
+      TwnNm: TownName
+      CtrySubDvsn: CountrySubDivision
+      Ctry: Country
+  Rsn:
+    Cd: AGNT
+  AddtlInf: AdditionalInformation

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

@@ -0,0 +1,56 @@
+title: StructuredRegulatoryReporting3
+description: |
+  StructuredRegulatoryReporting3
+
+  Information needed due to regulatory and statutory requirements.
+type: object
+properties:
+  Tp:
+    description: |
+      Type
+
+      Specifies the type of the information supplied in the regulatory reporting details.
+    $ref: ./Max35Text.yaml
+  Dt:
+    description: |
+      Date
+
+      Date related to the specified type of regulatory reporting details.
+    $ref: ./ISODate.yaml
+  Ctry:
+    description: |
+      Country
+
+      Country related to the specified type of regulatory reporting details.
+    $ref: ./CountryCode.yaml
+  Cd:
+    description: >
+      Code
+
+      Specifies the nature, purpose, and reason for the transaction to be reported
+      for regulatory and statutory requirements in a coded form.
+    $ref: ./Max10Text.yaml
+  Amt:
+    description: |
+      Amount
+
+      Amount of money to be reported for regulatory and statutory requirements.
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  Inf:
+    description: |
+      Information
+      Additional details that cater for specific domestic regulatory requirements.
+    anyOf:
+      - $ref: ./Max35Text.yaml
+      - items:
+          $ref: ./Max35Text.yaml
+        type: array
+example:
+  Tp: T1
+  Dt: '2018-01-01'
+  Ctry: CH
+  Cd: CHF
+  Amt:
+    Ccy: CHF
+    Amt: 1000
+  Inf: 12345

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

@@ -0,0 +1,29 @@
+title: SupplementaryData1
+description: >
+  Additional information that can not be captured in the structured fields
+  and/or any other specific block.
+type: object
+properties:
+  PlcAndNm:
+    description: >
+      PlaceAndName
+
+      Unambiguous reference to the location where the supplementary data must be inserted in
+      the message instance.
+    $ref: ./Max350Text.yaml
+  Envlp:
+    description: >
+      Envelope
+
+      Technical element wrapping the supplementary data.
+
+      Technical component that contains the validated supplementary data information. This technical
+      envelope allows to segregate the supplementary data information from any other information.
+    $ref: ./SupplementaryDataEnvelope1.yaml
+required:
+  - Envlp
+example:
+  PlcAndNm: Additional information
+  Envlp:
+    Cd: CH03
+    Prtry: Additional information

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

@@ -0,0 +1,8 @@
+title: SupplementaryDataEnvelope1
+description: >
+  SupplementaryDataEnvelope1
+
+  Technical component that contains the validated supplementary data information.
+  This technical envelope allows to segregate the supplementary data information from any other information.
+type: object
+

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

@@ -0,0 +1,49 @@
+title: TaxAmount3
+description: |
+  Information on the amount of the tax record.
+type: object
+properties:
+  Rate:
+    description: |
+      Rate
+
+      Rate used to calculate the tax.
+    $ref: ./PercentageRate.yaml
+  TaxblBaseAmt:
+    description: |
+      TaxableBaseAmount
+
+      Amount of money on which the tax is based.
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  TtlAmt:
+    description: |
+      TotalAmount
+
+      Total amount that is the result of the calculation of the tax for the record.
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  Dtls:
+    description: |
+      Details
+
+      Set of elements used to provide details on the tax period and amount.
+    anyOf:
+      - $ref: ./TaxRecordDetails3.yaml
+      - items:
+          $ref: ./TaxRecordDetails3.yaml
+        type: array
+example:
+  Rate: 0.0
+  TaxblBaseAmt:
+    Ccy: EUR
+    Amt: 0
+  TtlAmt:
+    Ccy: EUR
+    Amt: 0
+  Dtls:
+    Tp: T1
+    Ctry: CH
+    Cd: CHF
+    Amt:
+      Ccy: CHF
+      Amt: 1000
+    Inf: 12345

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

@@ -0,0 +1,20 @@
+title: TaxAuthorisation1
+description: |
+  Details of an authorised tax paying party.
+type: object
+properties:
+  Titl:
+    description: |
+      Title
+
+      Title or position of debtor or the debtor's authorised representative.
+    $ref: ./Max35Text.yaml
+  Nm:
+    description: |
+      Name
+
+      Name of the debtor or the debtor's authorised representative.
+    $ref: ./Max140Text.yaml
+example:
+  Titl: Mr
+  Nm: John Doe

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

@@ -0,0 +1,105 @@
+title: TaxData1
+description: >
+  Details about tax paid, or to be paid, to the government in accordance with
+  the law, including pre-defined parameters such as thresholds and type of account.
+type: object
+properties:
+  Cdtr:
+    description: |
+      Creditor
+
+      Party on the credit side of the transaction to which the tax applies.
+    $ref: ./TaxParty1.yaml
+  Dbtr:
+    description: |
+      Debtor
+
+      Party on the debit side of the transaction to which the tax applies.
+    $ref: ./TaxParty2.yaml
+  UltmtDbtr:
+    description: |
+      UltimateDebtor
+
+      Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.
+    $ref: ./TaxParty2.yaml
+  AdmstnZone:
+    description: |
+      AdministrationZone
+
+      Territorial part of a country to which the tax payment is related.
+    $ref: ./Max35Text.yaml
+  RefNb:
+    description: |
+      ReferenceNumber
+
+      Tax reference information that is specific to a taxing agency.
+    $ref: ./Max140Text.yaml
+  Mtd:
+    description: |
+      Method
+
+      Method used to indicate the underlying business or how the tax is paid.
+    $ref: ./Max35Text.yaml
+  TtlTaxblBaseAmt:
+    description: |
+      TotalTaxableBaseAmount
+
+      Total amount of money on which the tax is based.
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  TtlTaxAmt:
+    description: |
+      TotalTaxAmount
+
+      Total amount of money as result of the calculation of the tax.
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  Dt:
+    description: |
+      Date
+
+      Date by which tax is due.
+    $ref: ./ISODate.yaml
+  SeqNb:
+    description: |
+      SequenceNumber
+
+      Sequential number of the tax report
+    $ref: ./Number.yaml
+  Rcrd:
+    description: |
+      Record
+
+      Details of the tax record.
+    anyOf:
+      - $ref: ./TaxRecord3.yaml
+      - items:
+          $ref: ./TaxRecord3.yaml
+        type: array
+example:
+  Cdtr:
+    Titl: Mr
+    Nm: John Doe
+  Dbtr:
+    Titl: Mr
+    Nm: John Doe
+  UltmtDbtr:
+    Titl: Mr
+    Nm: John Doe
+  AdmstnZone: CH
+  RefNb: 12345
+  Mtd: A
+  TtlTaxblBaseAmt:
+    Ccy: CHF
+    Amt: 1000
+  TtlTaxAmt:
+    Ccy: CHF
+    Amt: 100
+  Dt: '2018-01-01'
+  SeqNb: 1
+  Rcrd:
+    Tp: T1
+    Ctry: CH
+    Cd: CHF
+    Amt:
+      Ccy: CHF
+      Amt: 1000
+    Inf: 12345