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

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

@@ -0,0 +1,203 @@
+title: CreditTransferTransaction67
+description: >
+  Provides further details specific to the individual transaction(s) included in
+  the message.
+type: object
+properties:
+  PmtId:
+    description: >
+      PaymentIdentification
+
+      Set of elements used to reference a payment instruction.
+    $ref: ./PaymentIdentification13.yaml
+  PmtTpInf:
+    description: >
+      PaymentTypeInformation
+
+       Set of elements used to further specify the type of transaction.
+    $ref: ./PaymentTypeInformation28.yaml
+  IntrBkSttlmAmt:
+    description: >
+      InterbankSettlementAmount
+
+      Amount of money moved between the instructing agent and the instructed agent.
+    $ref: ./ActiveCurrencyAndAmount.yaml
+  InstdAmt:
+    description: >
+      InstructedAmount
+
+      Amount of money to be moved between the debtor and creditor,
+      before deduction of charges, expressed in the currency as ordered by the initiating party.
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  XchgRate:
+    description: >
+      ExchangeRate
+
+      Factor used to convert an amount from one currency into another. This reflects the price at
+      which one currency was bought with another currency.
+    $ref: ./BaseOneRate.yaml
+  ChrgBr:
+    description: >
+      ChargeBearer
+
+      Specifies which party/parties will bear the charges associated with the processing of the
+      payment transaction.
+    $ref: ./ChargeBearerType1Code.yaml
+  ChrgsInf:
+    description: >
+      ChargesInformation
+
+      Provides information on the charges to be paid by the charge bearer(s) related to the
+      payment transaction
+    $ref: ./Charges16.yaml
+  Dbtr:
+    description: >
+      Debtor
+
+      Party that owes an amount of money to the (ultimate) creditor.
+    $ref: ./PartyIdentification272.yaml
+  DbtrAcct:
+    description: >
+      DebtorAccount
+
+      Unambiguous identification of the account of the debtor to which a debit entry will be made
+      as a result of the transaction.
+    $ref: ./CashAccount40.yaml
+  DbtrAgt:
+    description: >
+      DebtorAgent
+
+      Financial institution servicing an account for the debtor.
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  CdtrAgt:
+    description: >
+      CreditorAgent
+
+      Financial institution servicing an account for the creditor.
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  Cdtr:
+    description: >
+      Creditor
+
+      Party to which an amount of money is due.
+    $ref: ./PartyIdentification272.yaml
+  CdtrAcct:
+    description: >
+      CreditorAccount
+
+      Unambiguous identification of the account of the creditor to which a credit entry will be
+      posted as a result of the payment transaction.
+    $ref: ./CashAccount40.yaml
+  InstrForCdtrAgt:
+    description: >
+      InstructionForCreditorAgent
+
+      Set of elements used to provide information on the remittance advice.
+    $ref: ./InstructionForCreditorAgent3.yaml
+  InstrForNxtAgt:
+    description: >
+      InstructionForNextAgent
+
+      Set of elements used to provide information on the remittance advice.
+    $ref: ./InstructionForNextAgent1.yaml
+  Purp:
+    description: >
+      Purpose
+
+      Underlying reason for the payment transaction.
+    $ref: ./Purpose2Choice.yaml
+  RgltryRptg:
+    description: >
+      RegulatoryReporting
+
+      Information needed due to regulatory and statutory requirements.
+    $ref: ./RegulatoryReporting3.yaml
+  Tax:
+    description: >
+      Tax
+
+      Provides details on the 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,117 @@
+title: CreditTransferTransaction68
+description: >
+  Provides further details specific to the individual transaction(s) included in
+  the message.
+type: object
+properties:
+  PmtId:
+    description: >
+      PaymentIdentification
+
+      Set of elements used to reference a payment instruction.
+    $ref: ./PaymentIdentification13.yaml
+  PmtTpInf:
+    description: >
+      PaymentTypeInformation
+
+       Set of elements used to further specify the type of transaction.
+    $ref: ./PaymentTypeInformation28.yaml
+  IntrBkSttlmAmt:
+    description: >
+      InterbankSettlementAmount
+
+      Amount of money moved between the instructing agent and the instructed agent.
+    $ref: ./ActiveCurrencyAndAmount.yaml
+  Dbtr:
+    description: >
+      Debtor
+
+      Party that owes an amount of money to the (ultimate) creditor.
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  DbtrAcct:
+    description: >
+      DebtorAccount
+
+      Account used to process a payment.
+    $ref: ./CashAccount40.yaml
+  DbtrAgt:
+    description: >
+      DebtorAgent
+
+      Financial institution servicing an account for the debtor.
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  CdtrAgt:
+    description: >
+      CreditorAgent
+
+      Financial institution servicing an account for the creditor.
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  Cdtr:
+    description: >
+      Creditor
+
+      Party to which an amount of money is due.
+    $ref: ./BranchAndFinancialInstitutionIdentification8.yaml
+  CdtrAcct:
+    description: >
+      CreditorAccount
+
+      Account to which a credit entry is made.
+    $ref: ./CashAccount40.yaml
+  InstrForCdtrAgt:
+    description: >
+      InstructionForCreditorAgent
+
+      Set of elements used to provide information on the remittance advice.
+    $ref: ./InstructionForCreditorAgent3.yaml
+  Purp:
+    description: >
+      Purpose
+
+      Underlying reason for the payment transaction.
+    $ref: ./Purpose2Choice.yaml
+  VrfctnOfTerms:
+    description: >
+      VerificationOfTerms
+
+      Set of elements used to provide information on the underlying terms of the transaction.
+    $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,38 @@
+title: DateAndPlaceOfBirth1
+description: |
+  Details about date and place of birth of a person.
+type: object
+properties:
+  BirthDt:
+    description: >
+      BirthDate
+
+      Date on which a person is born.
+    $ref: ./ISODate.yaml
+  PrvcOfBirth:
+    description: >
+      ProvinceOfBirth
+
+      Province where a person was born.
+    $ref: ./Max35Text.yaml
+  CityOfBirth:
+    description: >
+      CityOfBirth
+
+      City where a person was born.
+    $ref: ./Max35Text.yaml
+  CtryOfBirth:
+    description: >
+      CountryOfBirth
+
+      Country where a person was born.
+    $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,23 @@
+title: DatePeriod2
+description: |
+  Range of time defined by a start date and an end date.
+type: object
+properties:
+  FrDt:
+    description: >
+      FromDate
+
+      Start date of the range.
+    $ref: ./ISODate.yaml
+  ToDt:
+    description: >
+      ToDate
+
+      End date of the range.
+    $ref: ./ISODate.yaml
+required:
+  - FrDt
+  - ToDt
+example:
+  FrDt: '2022-01-01T00:00:00.000Z'
+  ToDt: '2022-12-31T23:59:59.999Z'

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

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

@@ -0,0 +1,6 @@
+title: Exact4AlphaNumericText
+description: |
+  Specifies an alphanumeric string with a length of 4 characters.
+type: string
+pattern: ^[a-zA-Z0-9]{4}$
+example: 1234

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

@@ -0,0 +1,69 @@
+title: Execute_FIToFICustomerCreditTransferV13
+type: object
+properties:
+  GrpHdr:
+    description: >
+      GroupHeader.
+    $ref: ./GroupHeader129.yaml
+  CdtTrfTxInf:
+    description: >
+      CreditTransferTransactionInformation.
+    $ref: ./CreditTransferTransaction67.yaml
+required:
+  - GrpHdr
+  - CdtTrfTxInf
+example:
+  GrpHdr:
+    MsgId: 12345
+    CreDtTm: '2020-01-01T00:00:00Z'
+    PmtInstrXpryDtTm: '2020-01-01T00:00:00Z'
+    NbOfTxs: 1
+    SttlmInf:
+      SttlmMtd: INDA
+      SttlmAcct:
+        Id:
+          IBAN: 123
+      SttlmAcctOwnr:
+        Nm: John Doe
+      SttlmAcctSvcr:
+        BICFI: 123
+    CdtTrfTxInf:
+      PmtId:
+        InstrId: 123
+        EndToEndId: 123
+      PmtTpInf:
+        InstrPrty: NORM
+      InstdAmt:
+        Amt: 123
+        Ccy: EUR
+      ChrgBr: SLEV
+      CdtrAgt:
+        FinInstnId:
+          BICFI: 123
+      Cdtr:
+        Nm: John Doe
+      CdtrAcct:
+        Id:
+          IBAN: 123
+      RmtInf:
+        Ustrd: Test
+  CdtTrfTxInf:
+    PmtId:
+      InstrId: 123
+      EndToEndId: 123
+    PmtTpInf:
+      InstrPrty: NORM
+    InstdAmt:
+      Amt: 123
+      Ccy: EUR
+    ChrgBr: SLEV
+    CdtrAgt:
+      FinInstnId:
+        BICFI: 123
+    Cdtr:
+      Nm: John Doe
+    CdtrAcct:
+      Id:
+        IBAN: 123
+    RmtInf:
+      Ustrd: Test

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

@@ -0,0 +1,11 @@
+title: Extension
+type: object
+description: Data model for the complex type Extension.
+properties:
+  key:
+    $ref: ./ExtensionKey.yaml
+  value:
+    $ref: ./ExtensionValue.yaml
+required:
+  - key
+  - value

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

@@ -0,0 +1,5 @@
+title: ExtensionKey
+type: string
+minLength: 1
+maxLength: 32
+description: Extension key.

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

@@ -0,0 +1,15 @@
+title: ExtensionList
+type: object
+description: >
+  Data model for the complex type ExtensionList. An optional list of extensions,
+  specific to deployment.
+properties:
+  extension:
+    type: array
+    items:
+      $ref: ./Extension.yaml
+    minItems: 1
+    maxItems: 16
+    description: Number of Extension elements.
+required:
+  - extension

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

@@ -0,0 +1,5 @@
+title: ExtensionValue
+type: string
+minLength: 1
+maxLength: 128
+description: Extension value.

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

@@ -0,0 +1,8 @@
+title: ExternalAccountIdentification1Code
+description: >
+  Specifies the external account identification scheme name code in the format
+  of character string with a maximum length of 4 characters.
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

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

@@ -0,0 +1,8 @@
+title: ExternalCashAccountType1Code
+description: >
+  Specifies the nature, or use, of the cash account in the format of character
+  string with a maximum length of 4 characters.
+type: string
+minLength: 1
+maxLength: 4
+example: 1234

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

@@ -0,0 +1,9 @@
+description: >
+  Specifies the category purpose, as published in an external category purpose
+  code list.
+
+  External code sets can be downloaded from www.iso20022.org.
+maxLength: 4
+minLength: 1
+type: string
+example: 1234

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

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

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

@@ -0,0 +1,5 @@
+title: ExternalClearingSystemIdentification1Code
+type: string
+minLength: 1
+maxLength: 5
+example: 12345

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

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

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

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

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

@@ -0,0 +1,5 @@
+title: ExternalLocalInstrument1Code
+type: string
+minLength: 1
+maxLength: 35
+example: 12345

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

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

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

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

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

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

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

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

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

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

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

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

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

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