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

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

@@ -0,0 +1,6 @@
+title: BaseOneRate
+type: string
+description: |
+  Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.
+pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$
+example: 0.7

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

@@ -0,0 +1,29 @@
+title: BranchAndFinancialInstitutionIdentification6
+type: object
+description: >
+  Unique and unambiguous identification of a financial institution or a branch
+  of a financial institution.
+properties:
+  FinInstnId:
+    $ref: ./FinancialInstitutionIdentification18.yaml
+  BrnchId:
+    $ref: ./BranchData3.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/BranchAndFinancialInstitutionIdentification8.yaml

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

@@ -0,0 +1,28 @@
+title: BranchData3
+type: object
+description: >
+  Information that locates and identifies a specific branch of a financial
+  institution.
+properties:
+  Id:
+    $ref: ./Max35Text.yaml
+  LEI:
+    $ref: ./LEIIdentifier.yaml
+  Nm:
+    $ref: ./Max140Text.yaml
+  PstlAdr:
+    $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,23 @@
+title: BranchData5
+description: >
+  Information that locates and identifies a specific branch of a financial
+  institution.
+type: object
+properties:
+  Id:
+    $ref: ./Max35Text.yaml
+  LEI:
+    $ref: ./LEIIdentifier.yaml
+  Nm:
+    $ref: ./Max140Text.yaml
+  PstlAdr:
+    $ref: ./PostalAddress27.yaml
+example:
+  Id: 123
+  Nm: Oxford Street Branch
+  PstlAdr:
+    Ctry: GB
+    AdrLine:
+      - 1 Oxford Street
+      - London
+      - UK

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

@@ -0,0 +1,24 @@
+title: CashAccount40
+type: object
+description: |
+  Provides the details to identify an account.
+properties:
+  Id:
+    $ref: ./AccountIdentification4Choice.yaml
+  Tp:
+    $ref: ./CashAccountType2Choice.yaml
+  Ccy:
+    $ref: ./ActiveOrHistoricCurrencyCode.yaml
+  Nm:
+    $ref: ./Max70Text.yaml
+  Prxy:
+    $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,16 @@
+title: CashAccountType2Choice
+description: |
+  Specifies the nature, or use of the account.
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalCashAccountType1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CACC

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

@@ -0,0 +1,17 @@
+title: CategoryPurpose1Choice
+description: >
+  Contains details about high level purpose of the mandate based on a set of
+  pre-defined categories.
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalCategoryPurpose1Code.yaml
+  Prtry:
+    $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,15 @@
+title: ChargeType3Choice
+description: ChargeType3Choice Specifies the type of charge.
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalChargeType1Code.yaml
+  Prtry:
+    $ref: ./GenericIdentification3.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CASH

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

@@ -0,0 +1,25 @@
+title: Charges16
+description: |
+  NOTE: Unsure on description.
+type: object
+properties:
+  Amt:
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  Agt:
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  Tp:
+    $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,16 @@
+title: ClearingSystemIdentification2Choice
+description: |
+  Choice of a clearing system identifier.
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalClearingSystemIdentification1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CHQB

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

@@ -0,0 +1,16 @@
+title: ClearingSystemMemberIdentification2
+description: >
+  Unique identification, as assigned by a clearing system, to unambiguously
+  identify a member of the clearing system.
+type: object
+properties:
+  ClrSysId:
+    $ref: ./ClearingSystemIdentification2Choice.yaml
+  MmbId:
+    $ref: ./Max35Text.yaml
+required:
+  - MmbId
+example:
+  ClrSysId:
+    Cd: CHQB
+  MmbId: 123456789

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

@@ -0,0 +1,39 @@
+title: Contact13
+description: |
+  Specifies the details of the contact person.
+type: object
+properties:
+  NmPrfx:
+    $ref: ./NamePrefix2Code.yaml
+  Nm:
+    $ref: ./Max140Text.yaml
+  PhneNb:
+    $ref: ./PhoneNumber.yaml
+  MobNb:
+    $ref: ./PhoneNumber.yaml
+  FaxNb:
+    $ref: ./PhoneNumber.yaml
+  URLAdr:
+    $ref: ./Max2048Text.yaml
+  EmailAdr:
+    $ref: ./Max256Text.yaml
+  EmailPurp:
+    $ref: ./Max35Text.yaml
+  JobTitl:
+    $ref: ./Max35Text.yaml
+  Rspnsblty:
+    $ref: ./Max35Text.yaml
+  Dept:
+    $ref: ./Max70Text.yaml
+  Othr:
+    $ref: ./OtherContact1.yaml
+  PrefrdMtd:
+    $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,36 @@
+title: Contact4
+description: |
+  Specifies the details of the contact person.
+type: object
+properties:
+  NmPrfx:
+    $ref: ./NamePrefix2Code.yaml
+  Nm:
+    $ref: ./Max140Text.yaml
+  PhneNb:
+    $ref: ./PhoneNumber.yaml
+  MobNb:
+    $ref: ./PhoneNumber.yaml
+  FaxNb:
+    $ref: ./PhoneNumber.yaml
+  EmailAdr:
+    $ref: ./Max2048Text.yaml
+  EmailPurp:
+    $ref: ./Max35Text.yaml
+  JobTitl:
+    $ref: ./Max35Text.yaml
+  Rspnsblty:
+    $ref: ./Max35Text.yaml
+  Dept:
+    $ref: ./Max70Text.yaml
+  Othr:
+    $ref: ./OtherContact1.yaml
+  PrefrdMtd:
+    $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,4 @@
+title: CountryCode
+type: string
+pattern: ^[A-Z]{2,2}$
+example: US

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

@@ -0,0 +1,125 @@
+title: CreditTransferTransaction67
+description: >
+  Provides further details specific to the individual transaction(s) included in
+  the message.
+type: object
+properties:
+  PmtId:
+    $ref: ./PaymentIdentification13.yaml
+  PmtTpInf:
+    $ref: ./PaymentTypeInformation28.yaml
+  IntrBkSttlmAmt:
+    $ref: ./ActiveCurrencyAndAmount.yaml
+  InstdAmt:
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  XchgRate:
+    $ref: ./BaseOneRate.yaml
+  ChrgBr:
+    $ref: ./ChargeBearerType1Code.yaml
+  ChrgsInf:
+    $ref: ./Charges16.yaml
+  Dbtr:
+    $ref: ./PartyIdentification272.yaml
+  DbtrAcct:
+    $ref: ./CashAccount40.yaml
+  DbtrAgt:
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  CdtrAgt:
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  Cdtr:
+    $ref: ./PartyIdentification272.yaml
+  CdtrAcct:
+    $ref: ./CashAccount40.yaml
+  InstrForCdtrAgt:
+    $ref: ./InstructionForCreditorAgent3.yaml
+  InstrForNxtAgt:
+    $ref: ./InstructionForNextAgent1.yaml
+  Purp:
+    $ref: ./Purpose2Choice.yaml
+  RgltryRptg:
+    $ref: ./RegulatoryReporting3.yaml
+  Tax:
+    $ref: ./TaxData1.yaml
+  VrfctnOfTerms:
+    $ref: ./CryptographicLockChoice.yaml
+required:
+  - PmtId
+  - IntrBkSttlmAmt
+  - ChrgBr
+  - Dbtr
+  - DbtrAgt
+  - CdtrAgt
+  - Cdtr
+example:
+  PmtId:
+    InstrId: INSTRID
+    EndToEndId: ENDTOENDID
+  PmtTpInf:
+    LclInstrm:
+      Cd: CHQB
+      Prtry: PROPRIETARY
+    SeqTp: SEQTP
+  IntrBkSttlmAmt:
+    ActiveCurrencyAndAmount: 123.45
+    Ccy: USD
+  InstdAmt:
+    ActiveOrHistoricCurrencyAndAmount: 123.45
+    Ccy: USD
+  XchgRate: 123.45
+  ChrgBr: SHAR
+  ChrgsInf:
+    Amt:
+      ActiveOrHistoricCurrencyAndAmount: 123.45
+      Ccy: USD
+    Agt:
+      BrnchId:
+        Id: BRANCHID
+      FinInstnId:
+        BICFI: BICFI
+    Tp:
+      Cd: SHAR
+  Dbtr:
+    Nm: NAME
+    PstlAdr:
+      AdrTp: ADDR
+      BldgNb: BLDGNB
+      Ctry: CTRY
+      TwnNm: TWNNM
+      PstCd: PSTCD
+      StrtNm: STRTNM
+  DbtrAcct:
+    Id:
+      IBAN: IBAN
+  DbtrAgt:
+    BrnchId:
+      Id: BRANCHID
+    FinInstnId:
+      BICFI: BICFI
+  CdtrAgt:
+    BrnchId:
+      Id: BRANCHID
+    FinInstnId:
+      BICFI: BICFI
+  Cdtr:
+    Nm: NAME
+    PstlAdr:
+      AdrTp: ADDR
+      BldgNb: BLDGNB
+      Ctry: CTRY
+      TwnNm: TWNNM
+      PstCd: PSTCD
+      StrtNm: STRTNM
+  CdtrAcct:
+    Id:
+      IBAN: IBAN
+  InstrForCdtrAgt:
+    Cd: CODE
+  InstrForNxtAgt:
+    Cd: CODE
+  Purp:
+    Cd: CASH
+  RgltryRptg:
+    Dbtr: TRUE
+    Cdtr: TRUE
+  Tax:
+    Cdtr

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

@@ -0,0 +1,69 @@
+title: CreditTransferTransaction68
+description: >
+  Provides further details specific to the individual transaction(s) included in
+  the message.
+type: object
+properties:
+  PmtId:
+    $ref: ./PaymentIdentification13.yaml
+  PmtTpInf:
+    $ref: ./PaymentTypeInformation28.yaml
+  IntrBkSttlmAmt:
+    $ref: ./ActiveCurrencyAndAmount.yaml
+  Dbtr:
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  DbtrAcct:
+    $ref: ./CashAccount40.yaml
+  DbtrAgt:
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  CdtrAgt:
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  Cdtr:
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  CdtrAcct:
+    $ref: ./CashAccount40.yaml
+  InstrForCdtrAgt:
+    $ref: ./InstructionForCreditorAgent3.yaml
+  Purp:
+    $ref: ./Purpose2Choice.yaml
+  VrfctnOfTerms:
+    $ref: ./CryptographicLockChoice.yaml
+required:
+  - PmtId
+  - IntrBkSttlmAmt
+  - Dbtr
+  - Cdtr
+example:
+  PmtId:
+    InstrId: INSTRID
+    EndToEndId: ENDTOENDID
+  PmtTpInf:
+    LclInstrm:
+      Cd: CHQB
+      Prtry: PROPRIETARY
+  IntrBkSttlmAmt:
+    Amount: 123.45
+    Ccy: EUR
+  Dbtr:
+    Nm: Debtor Name
+  DbtrAcct:
+    Id:
+      IBAN: IBAN
+  DbtrAgt:
+    FinInstnId:
+      BICFI: BICFI
+  CdtrAgt:
+    FinInstnId:
+      BICFI: BICFI
+  Cdtr:
+    Nm: Creditor Name
+  CdtrAcct:
+    Id:
+      IBAN: IBAN
+  InstrForCdtrAgt:
+    Cd: INSTRUCTION
+  Purp:
+    Cd: CHAR
+  VrfctnOfTerms:
+    Cntt: CONTENT
+    CnttTp: PROPRIETARY

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

@@ -0,0 +1,16 @@
+title: CryptographicLockChoice
+description: |
+  NOTE: Unsure on description.
+type: object
+properties:
+  IlpV4PrepPacket:
+    $ref: ./hexBinary.yaml
+  Sh256Sgntr:
+    $ref: ./Exact32HexBinaryText.yaml
+oneOf:
+  - required:
+      - IlpV4PrepPacket
+  - required:
+      - Sh256Sgntr
+example:
+  IlpV4PrepPacket: 1234567890ABCDEF

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

@@ -0,0 +1,22 @@
+title: DateAndPlaceOfBirth1
+description: |
+  Details about date and place of birth of a person.
+type: object
+properties:
+  BirthDt:
+    $ref: ./ISODate.yaml
+  PrvcOfBirth:
+    $ref: ./Max35Text.yaml
+  CityOfBirth:
+    $ref: ./Max35Text.yaml
+  CtryOfBirth:
+    $ref: ./CountryCode.yaml
+required:
+  - BirthDt
+  - CityOfBirth
+  - CtryOfBirth
+example:
+  BirthDt: 1970-01-01
+  PrvcOfBirth: ON
+  CityOfBirth: Ottawa
+  CtryOfBirth: CA

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

@@ -0,0 +1,15 @@
+title: DatePeriod2
+description: |
+  Range of time defined by a start date and an end date.
+type: object
+properties:
+  FrDt:
+    $ref: ./ISODate.yaml
+  ToDt:
+    $ref: ./ISODate.yaml
+required:
+  - FrDt
+  - ToDt
+example:
+  FrDt: 2020-01-01
+  ToDt: 2020-12-31

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

@@ -0,0 +1,11 @@
+title: ErrorCode
+type: string
+pattern: ^[1-9]\d{3}$
+description: >-
+  The API data type ErrorCode is a JSON String of four characters, consisting of
+  digits only. Negative numbers are not allowed. A leading zero is not allowed.
+  Each error code in the API is a four-digit number, for example, 1234, where
+  the first number (1 in the example) represents the high-level error category,
+  the second number (2 in the example) represents the low-level error category,
+  and the last two numbers (34 in the example) represent the specific error.
+example: '5100'

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

@@ -0,0 +1,5 @@
+title: ErrorDescription
+type: string
+minLength: 1
+maxLength: 128
+description: Error description string.

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

@@ -0,0 +1,13 @@
+title: ErrorInformation
+type: object
+description: Data model for the complex type ErrorInformation.
+properties:
+  errorCode:
+    $ref: ./ErrorCode.yaml
+  errorDescription:
+    $ref: ./ErrorDescription.yaml
+  extensionList:
+    $ref: ./ExtensionList.yaml
+required:
+  - errorCode
+  - errorDescription

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

@@ -0,0 +1,8 @@
+title: ErrorInformationResponse
+type: object
+description: >
+  Data model for the complex type object that contains an optional element
+  ErrorInformation used along with 4xx and 5xx responses.
+properties:
+  errorInformation:
+    $ref: ./ErrorInformation.yaml

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

@@ -0,0 +1,6 @@
+title: Exact32HexBinaryText
+description: |
+  Specifies a hexadecimal string with a length of 32 characters.
+type: string
+pattern: ^([0-9A-F][0-9A-F]){32}$
+example: 1234567890ABCDEF1234567890ABCDEF