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

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

@@ -0,0 +1,38 @@
+title: BranchAndFinancialInstitutionIdentification8
+type: object
+description: >
+  Unique and unambiguous identification of a financial institution or a branch
+  of a financial institution.
+properties:
+  FinInstnId:
+    description: >
+      FinancialInstitutionIdentification
+
+      Unique and unambiguous identification of a financial institution or a branch of a financial
+      institution.
+    $ref: ./FinancialInstitutionIdentification23.yaml
+  BrnchId:
+    description: >
+      BranchIdentification
+
+       Identifies a specific branch of a financial institution.
+    $ref: ./BranchData5.yaml
+required:
+  - FinInstnId
+example:
+  FinInstnId:
+    BICFI: J5BMVH7D
+  BrnchId:
+    Id: 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

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

@@ -0,0 +1,44 @@
+title: BranchData3
+type: object
+description: >
+  Information that locates and identifies a specific branch of a financial
+  institution.
+properties:
+  Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification of a branch of a financial institution.
+    $ref: ./Max35Text.yaml
+  LEI:
+    description: >
+      Legal Entity Identifier
+
+      Legal entity identification for the branch 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: >
+      Postal Address
+
+      Information that locates and identifies a specific address, as defined by postal services.
+    $ref: ./PostalAddress24.yaml
+example:
+  Id: 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

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

@@ -0,0 +1,45 @@
+title: BranchData5
+description: >
+  Information that locates and identifies a specific branch of a financial
+  institution.
+type: object
+properties:
+  Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification of a branch of a financial institution.
+    $ref: ./Max35Text.yaml
+  LEI:
+    description: >
+      LEI
+
+      Legal entity identification for the branch 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
+example:
+  Id: 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

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

@@ -0,0 +1,53 @@
+title: CashAccount40
+type: object
+description: |
+  Provides the details to identify an account.
+properties:
+  Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification for the account between the account owner and the
+      account servicer.
+    $ref: ./AccountIdentification4Choice.yaml
+  Tp:
+    description: >
+      Type
+
+      Specifies the nature, or use of the account.
+    $ref: ./CashAccountType2Choice.yaml
+  Ccy:
+    description: >
+      Currency
+
+      Definition: Identification of the currency in which the account is held.
+
+      Usage: Currency should only be used in case one and the same account number covers several
+      currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.
+    $ref: ./ActiveOrHistoricCurrencyCode.yaml
+  Nm:
+    description: >
+      Name
+
+      Definition: Name of the account, as assigned by the account servicing institution, in agreement with the
+      account owner in order to provide an additional means of identification of the account.
+
+      Usage: The account name is different from the account owner name. The account name is used in
+      certain user communities to provide a means of identifying the account, in addition to the account
+      owner's identity and the account number.
+    $ref: ./Max70Text.yaml
+  Prxy:
+    description: >
+      Proxy
+
+      Specifies an alternate assumed name for the identification of the account.
+    $ref: ./ProxyAccountIdentification1.yaml
+example:
+  Id:
+    IBAN: BE71096123456769
+  Tp:
+    Cd: CACC
+  Ccy: EUR
+  Nm: My account
+  Prxy:
+    Id: 12345

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

@@ -0,0 +1,24 @@
+title: CashAccountType2Choice
+description: |
+  Specifies the nature, or use of the account.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Account type, in a coded form.
+    $ref: ./ExternalCashAccountType1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Nature or use of the account in a proprietary form.
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CACC

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

@@ -0,0 +1,25 @@
+title: CategoryPurpose1Choice
+description: >
+  Contains details about high level purpose of the mandate based on a set of
+  pre-defined categories.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Category purpose, as published in an external category purpose code list.
+    $ref: ./ExternalCategoryPurpose1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Category purpose, in a proprietary form.
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CASH

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

@@ -0,0 +1,23 @@
+title: ChargeBearerType1Code
+description: >
+  Specifies which party(ies) will pay charges due for processing of the
+  instruction.
+
+  DEBT BorneByDebtor All transaction charges are to be borne by the debtor.
+
+  CRED BorneByCreditor All transaction charges are to be borne by the creditor.
+
+  SHAR Shared In a credit transfer context, means that transaction charges on
+  the sender side are to be borne by the debtor, transaction charges on the receiver side are to
+  be borne by the creditor. In a direct debit context, means that transaction charges on the sender side
+  are to be borne by the creditor, transaction charges on the receiver
+
+  SLEV FollowingServiceLevel Charges are to be applied following the rules
+  agreed in the service level.
+type: string
+enum:
+  - DEBT
+  - CRED
+  - SHAR
+  - SLEV
+example: DEBT

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

@@ -0,0 +1,26 @@
+title: ChargeType3Choice
+description: >
+  ChargeType3Choice
+
+  Specifies the type of charge.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Charge type, in a coded form.
+    $ref: ./ExternalChargeType1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Type of charge in a proprietary form, as defined by the issuer.
+    $ref: ./GenericIdentification3.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CASH

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

@@ -0,0 +1,39 @@
+title: Charges16
+description: |
+  NOTE: Unsure on description.
+
+  Seemingly a generic schema for charges, with an amount, agent, and type.
+type: object
+properties:
+  Amt:
+    description: >
+      Amount
+
+       Transaction charges to be paid by the charge bearer.
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  Agt:
+    description: >
+      Agent
+
+      Agent that takes the transaction charges or to which the transaction charges are due.
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  Tp:
+    description: >
+      Type
+
+       Defines the type of charges.
+    $ref: ./ChargeType3Choice.yaml
+required:
+  - Amt
+  - Agt
+example:
+  Amt:
+    ActiveOrHistoricCurrencyAndAmount: 123.45
+    Ccy: USD
+  Agt:
+    BrnchId:
+      Id: BRANCHID
+    FinInstnId:
+      BICFI: BICFI
+  Tp:
+    Cd: SHAR

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

@@ -0,0 +1,22 @@
+title: ClearingChannel2Code
+description: >
+  Specifies the clearing channel for the routing of the transaction, as part of
+  the payment type identification.
+
+  RTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross
+  settlement system.
+
+  RTNS RealTimeNetSettlementSystem Clearing channel is a real-time net
+  settlement system.
+
+  MPNS MassPaymentNetSystem Clearing channel is a mass payment  net settlement
+  system.
+
+  BOOK BookTransfer Payment through internal book transfer.
+type: string
+enum:
+  - RTGS
+  - RTNS
+  - MPNS
+  - BOOK
+example: RTGS

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

@@ -0,0 +1,25 @@
+title: ClearingSystemIdentification2Choice
+description: |
+  Choice of a clearing system identifier.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Identification of a member of a clearing system
+    $ref: ./ExternalClearingSystemIdentification1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Identification code for a clearing system, that has not yet been identified in the list of clearing
+      systems.
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CHQB

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

@@ -0,0 +1,25 @@
+title: ClearingSystemMemberIdentification2
+description: >
+  Unique identification, as assigned by a clearing system, to unambiguously
+  identify a member of the clearing system.
+type: object
+properties:
+  ClrSysId:
+    description: >
+      ClearingSystemIdentification.
+
+      Specification of a pre-agreed offering between clearing agents or the channel through which
+      the payment instruction is processed.
+    $ref: ./ClearingSystemIdentification2Choice.yaml
+  MmbId:
+    description: >
+      MemberIdentification.
+
+      Identification of a member of a clearing system.
+    $ref: ./Max35Text.yaml
+required:
+  - MmbId
+example:
+  ClrSysId:
+    Cd: CHQB
+  MmbId: 123456789

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

@@ -0,0 +1,92 @@
+title: Contact13
+description: |
+  Specifies the details of the contact person.
+type: object
+properties:
+  NmPrfx:
+    description: >
+      NamePrefix
+
+      Specifies the terms used to formally address a 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
+  URLAdr:
+    description: >
+      URLAddress
+
+      Address for the Universal Resource Locator (URL), for example an address used over the
+      www (HTTP) service.
+    $ref: ./Max2048Text.yaml
+  EmailAdr:
+    description: >
+      EmailAddress
+
+      Address for electronic mail (e-mail).
+    $ref: ./Max256Text.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: >
+      OtherContact
+
+      Contact details in another form.
+    $ref: ./OtherContact1.yaml
+  PrefrdMtd:
+    description: >
+      PreferredContactMethod
+
+      Preferred method used to reach the contact.
+    $ref: ./PreferredContactMethod2Code.yaml
+example:
+  NmPrfx: Mr
+  Nm: John Doe
+  PhneNb: +123-123-321
+  MobNb: +123-123-321
+  FaxNb: +123-123-321
+  URLAdr: http://www.example.com
+  EmailAdr: example@example.com

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

@@ -0,0 +1,84 @@
+title: Contact4
+description: |
+  Specifies the details of the contact person.
+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
+  Nm: John Doe
+  PhneNb: +123-123-321
+  MobNb: +123-123-321
+  FaxNb: +123-123-321
+  EmailAdr: example@example.com

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

@@ -0,0 +1,7 @@
+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).