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

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

@@ -0,0 +1,77 @@
+title: GetParties_IdentificationVerificationReportV03
+type: object
+properties:
+  Assgnmt:
+    description: >
+      Assignment
+
+      Identifies the identification assignment.
+    $ref: ./IdentificationAssignment3.yaml
+  Rpt:
+    description: >
+      Report
+
+      Information concerning the verification of the identification data for which verification was
+      requested.
+    $ref: ./VerificationReport4.yaml
+  SplmtryData:
+    description: >
+      SupplementaryData
+
+      Additional information that cannot be captured in the structured elements and/or any other specific block.
+    $ref: ./SupplementaryData1.yaml
+required:
+  - Assgnmt
+  - Rpt
+example:
+  Assgnmt:
+    MsgId: 123
+    CreDtTm: '2020-01-01T00:00:00Z'
+    Assgnr:
+      OrgId:
+        Othr:
+          Id: 123
+          SchmeNm:
+            Cd: BIC
+          Issr: BIC
+    Assgne:
+      OrgId:
+        Othr:
+          Id: DFSPID
+  Rpt:
+    OrgnlId: 12345678
+    Vrfctn: true
+    UpdtdPtyAndAcctId:
+      Pty:
+        Nm: John Doe
+        PstlAdr:
+          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
+        Id:
+          OrgId:
+            Othr:
+              Id: 18761231234
+            SchmeNm:
+              Prtry: MSISDN
+        CtryOfRes: BE
+        CtctDtls:
+          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/GroupHeader113.yaml

@@ -0,0 +1,72 @@
+title: GroupHeader113
+description: >
+  Set of characteristics shared by all individual transactions included in the
+  message.
+type: object
+properties:
+  MsgId:
+    $ref: ./Max35Text.yaml
+  CreDtTm:
+    $ref: ./ISODateTime.yaml
+  NbOfTxs:
+    $ref: ./Max15NumericText.yaml
+  TtlIntrBkSttlmAmt:
+    $ref: ./ActiveCurrencyAndAmount.yaml
+  SttlmInf:
+    $ref: ./SettlementInstruction15.yaml
+  PmtTpInf:
+    $ref: ./PaymentTypeInformation28.yaml
+  CdtTrfTxInf:
+    $ref: ./CreditTransferTransaction68.yaml
+required:
+  - MsgId
+  - CreDtTm
+  - NbOfTxs
+  - SttlmInf
+  - CdtTrfTxInf
+example:
+  MsgId: 12345
+  CreDtTm: '2020-01-01T00:00:00Z'
+  NbOfTxs: 1
+  TtlIntrBkSttlmAmt:
+    Ccy: EUR
+    Value: 100.0
+  SttlmInf:
+    SttlmMtd: INDA
+    SttlmAcct:
+      Id:
+        IBAN: BE71096123456769
+      Ccy: EUR
+    SttlmAcctOwnr:
+      Nm: Name
+    SttlmAcctSvcr:
+      Nm: Name
+    SttlmAgt:
+      FinInstnId:
+        BICFI: BIC
+  PmtTpInf:
+    InstrPrty: NORM
+    CtgyPurp: CASH
+  CdtTrfTxInf:
+    PmtId:
+      InstrId: 12345
+      EndToEndId: 12345
+    Amt:
+      InstdAmt:
+        Ccy: EUR
+        Value: 100.0
+    Cdtr:
+      Nm: Name
+    CdtrAcct:
+      Id:
+        IBAN: BE71096123456769
+      Ccy: EUR
+    CdtrAgt:
+      FinInstnId:
+        BICFI: BIC
+    CdtrAgtAcct:
+      Id:
+        IBAN: BE71096123456769
+      Ccy: EUR
+    RmtInf:
+      Ustrd: Test

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

@@ -0,0 +1,54 @@
+title: GroupHeader120
+description: >
+  Set of characteristics shared by all individual transactions included in the
+  message.
+type: object
+properties:
+  MsgId:
+    description: >
+      MessageIdentification
+
+      Definition: Point to point reference, as assigned by the instructing party, and sent to the next party in the
+      chain to unambiguously identify the message.
+
+      Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party
+      for a pre-agreed period.
+    $ref: ./Max35Text.yaml
+  CreDtTm:
+    description: >
+      CreationDateTime
+
+      Date and time at which the message was created.
+    $ref: ./ISODateTime.yaml
+  TxInfAndSts:
+    description: >
+      TransactionInformationAndStatus
+
+      Definition: Agent that instructs the next party in the chain to carry out the (set of) instruction(s).
+
+      Usage: The instructing agent is the party sending the status message and not the party that sent the
+      original instruction that is being reported on.
+    $ref: ./PaymentTransaction163.yaml
+required:
+  - MsgId
+  - CreDtTm
+example:
+  MsgId: 12345
+  CreDtTm: '2020-01-01T00:00:00Z'
+  TxInfAndSts:
+    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/GroupHeader129.yaml

@@ -0,0 +1,58 @@
+title: GroupHeader129
+description: >
+  Set of characteristics shared by all individual transactions included in the
+  message.
+type: object
+properties:
+  MsgId:
+    $ref: ./Max35Text.yaml
+  CreDtTm:
+    $ref: ./ISODateTime.yaml
+  PmtInstrXpryDtTm:
+    $ref: ./ISODateTime.yaml
+  NbOfTxs:
+    $ref: ./Max15NumericText.yaml
+  SttlmInf:
+    $ref: ./SettlementInstruction15.yaml
+  CdtTrfTxInf:
+    $ref: ./CreditTransferTransaction67.yaml
+required:
+  - MsgId
+  - CreDtTm
+  - NbOfTxs
+  - SttlmInf
+  - CdtTrfTxInf
+example:
+  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

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

@@ -0,0 +1,12 @@
+title: IBAN2007Identifier
+description: >
+  The International Bank Account Number is a code used internationally by
+  financial institutions to uniquely identify the account of a customer
+  at a financial institution as described in the 2007 edition of the
+  ISO 13616 standard "Banking and related financial services -
+
+  International Bank Account Number (IBAN)" and replaced by the more recent
+  edition of the standard.
+type: string
+pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
+example: FR1420041010050500013M02606

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

@@ -0,0 +1,9 @@
+title: ISODate
+description: >
+  A particular point in the progression of time in a calendar year
+  expressed in the YYYY-MM-DD format. This representation is defined in
+  "XML Schema Part 2: Datatypes Second Edition -
+  W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
+type: string
+format: date
+example: '2013-03-07'

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

@@ -0,0 +1,21 @@
+title: ISODateTime
+description: |
+  A particular point in the progression of time defined by a mandatory
+  date and a mandatory time component, expressed in either UTC time
+  format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format
+  (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format
+  (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in
+  "XML Schema Part 2: Datatypes Second Edition -
+  W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
+
+  Note on the time format:
+  1) beginning / end of calendar day
+  00:00:00 = the beginning of a calendar day
+  24:00:00 = the end of a calendar day
+
+  2) fractions of second in time format
+  Decimal fractions of seconds may be included. In this case, the
+  involved parties shall agree on the maximum number of digits that are allowed.
+type: string
+format: datetime
+example: '2013-03-07T14:44:30.000Z'

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

@@ -0,0 +1,6 @@
+title: ISOYear
+description: |
+  Year represented by YYYY (ISO 8601).
+type: string
+pattern: ^\d{4}(Z|([+-]\d{2}:\d{2})){0,1}$
+example: 2019

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

@@ -0,0 +1,47 @@
+title: IdentificationAssignment3
+type: object
+properties:
+  MsgId:
+    $ref: ./Max35Text.yaml
+  CreDtTm:
+    description: >
+      CreationDateTime
+
+      Date and time at which the identification assignment was created.
+    $ref: ./ISODateTime.yaml
+  Assgnr:
+    description: >
+      Assignor
+
+      Party that assigns the identification assignment to another party. This is also the sender of
+      the message.
+    $ref: ./Party40Choice.yaml
+  Assgne:
+    description: >
+      Assignee
+
+      Party that the identification assignment is assigned to. This is also the receiver of the
+      message.
+    $ref: ./Party40Choice.yaml
+required:
+  - MsgId
+  - CreDtTm
+  - Assgnr
+  - Assgne
+example:
+  MsgId: 123
+  CreDtTm: '2020-01-01T00:00:00Z'
+  Assgnr:
+    OrgId:
+      Othr:
+        Id: 123
+        SchmeNm:
+          Cd: BIC
+        Issr: BIC
+  Assgne:
+    OrgId:
+      Othr:
+        Id: 123
+        SchmeNm:
+          Cd: BIC
+        Issr: BIC

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

@@ -0,0 +1,34 @@
+title: IdentificationInformation4
+type: object
+properties:
+  Pty:
+    description: >
+      Party
+
+      Account owner that owes an amount of money or to whom an amount of money is due.
+    $ref: ./PartyIdentification135.yaml
+  Acct:
+    description: >
+      Account
+
+      Unambiguous identification of the account of a party.
+    $ref: ./CashAccount40.yaml
+  Agt:
+    description: >
+      Agent
+
+      Financial institution servicing an account for a party.
+    $ref: ./BranchAndFinancialInstitutionIdentification6.yaml
+example:
+  Pty:
+    Id:
+      OrgId:
+        AnyBIC:
+          BICFI: BICFI
+    CtryOfRes: FI
+  Acct:
+    Id:
+      IBAN: FI2112345600000785
+  Agt:
+    FinInstnId:
+      BICFI: BICFI

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

@@ -0,0 +1,8 @@
+title: IdentificationVerificationIndicator
+type: boolean
+example: true
+description: |
+  Definition: Identifies whether the party and/or account information received is correct.
+
+  • Meaning When True: Indicates that the identification information received is correct.
+  • Meaning When False: Indicates that the identification information received is incorrect

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

@@ -0,0 +1,14 @@
+title: Instruction4Code
+description: >
+  Specifies further instructions concerning the processing of a payment
+  instruction, provided by the sending clearing agent to the next agent(s).
+
+  PHOA PhoneNextAgent Please advise/contact next agent by phone.
+
+  TELA TelecomNextAgent Please advise/contact next agent by the most efficient
+  means of telecommunication.
+type: string
+enum:
+  - PHOA
+  - TELA
+example: PHOA

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

@@ -0,0 +1,23 @@
+title: InstructionForCreditorAgent3
+description: >
+  Further information related to the processing of the payment instruction,
+  provided by the initiating party, and intended for the creditor agent.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Coded information related to the processing of the payment instruction, provided by the
+      initiating party, and intended for the creditor's agent.
+    $ref: ./ExternalCreditorAgentInstruction1Code.yaml
+  InstrInf:
+    description: >
+      InstructionInformation
+
+      Further information complementing the coded instruction or instruction to the creditor's agent
+      that is bilaterally agreed or specific to a user community.
+    $ref: ./Max140Text.yaml
+example:
+  Cd: PHOA
+  InstrInf: Please advise/contact next agent by phone.

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

@@ -0,0 +1,23 @@
+title: InstructionForNextAgent1
+description: >
+  Further information related to the processing of the payment instruction,
+  provided by the initiating party, and intended for the creditor agent.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Coded information related to the processing of the payment instruction, provided by the
+      initiating party, and intended for the next agent in the payment chain.
+    $ref: ./Instruction4Code.yaml
+  InstrInf:
+    description: >
+      InstructionInformation
+
+      Further information complementing the coded instruction or instruction to the next agent that
+      is bilaterally agreed or specific to a user community.
+    $ref: ./Max140Text.yaml
+example:
+  Cd: PHOA
+  InstrInf: Please advise/contact next agent by phone

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

@@ -0,0 +1,8 @@
+title: LEIIdentifier
+description: >
+  Legal Entity Identifier is a code allocated to a party as described in
+  ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
+  ^([0-9A-Z]{18,18}[0-9]{2,2})$
+type: string
+pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$
+example: 529900T8BM49AURSDO55

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

@@ -0,0 +1,22 @@
+title: LocalInstrument2Choice
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Specifies the local instrument, as published in an external local instrument code list.
+    $ref: ./ExternalLocalInstrument1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Specifies the local instrument, as a proprietary code
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CH03

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

@@ -0,0 +1,7 @@
+title: Max105Text
+description: |
+  Specifies a character string with a maximum length of 105 characters.
+type: string
+minLength: 1
+maxLength: 105
+example: 12345

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

@@ -0,0 +1,7 @@
+title: Max10Text
+description: |
+  Specifies a character string with a maximum length of 10 characters.
+type: string
+minLength: 1
+maxLength: 10
+example: 1234567890

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

@@ -0,0 +1,7 @@
+title: Max128Text
+description: |
+  Specifies a character string with a maximum length of 128 characters.
+type: string
+minLength: 1
+maxLength: 128
+example: 12345

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

@@ -0,0 +1,7 @@
+title: Max140Text
+description: |
+  Specifies a character string with a maximum length of 140 characters.
+type: string
+minLength: 1
+maxLength: 140
+example: 12345

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

@@ -0,0 +1,6 @@
+title: Max15NumericText
+description: |
+  Specifies a numeric string with a maximum length of 15 digits.
+type: string
+pattern: ^[0-9]{1,15}$
+example: 123456789012345

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

@@ -0,0 +1,7 @@
+title: Max16Text
+description: |
+  Specifies a character string with a maximum length of 16 characters.
+type: string
+minLength: 1
+maxLength: 16
+example: 1234567890123456

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

@@ -0,0 +1,7 @@
+title: Max2048Text
+description: |
+  Specifies a character string with a maximum length of 2048 characters.
+type: string
+minLength: 1
+maxLength: 2048
+example: 2048

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

@@ -0,0 +1,7 @@
+title: Max256Text
+description: |
+  Specifies a character string with a maximum length of 256 characters.
+type: string
+minLength: 1
+maxLength: 256
+example: 256

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

@@ -0,0 +1,7 @@
+title: Max34Text
+description: |
+  Specifies a character string with a maximum length of 34 characters.
+type: string
+minLength: 1
+maxLength: 34
+example: 1234567890123456789012345678901234

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

@@ -0,0 +1,7 @@
+title: Max350Text
+description: |
+  Specifies a character string with a maximum length of 350 characters.
+type: string
+minLength: 1
+maxLength: 350
+example: 350

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

@@ -0,0 +1,7 @@
+title: Max35Text
+description: |
+  Specifies a character string with a maximum length of 35 characters.
+type: string
+minLength: 1
+maxLength: 35
+example: 12345678901234567890123456789012345

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

@@ -0,0 +1,7 @@
+title: Max4Text
+description: |
+  Specifies a 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/Max70Text.yaml

@@ -0,0 +1,7 @@
+title: Max70Text
+description: |
+  Specifies a character string with a maximum length of 70 characters.
+type: string
+minLength: 1
+maxLength: 70
+example: 1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890

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

@@ -0,0 +1,10 @@
+description: |
+  Specifies the terms used to formally address a person.
+enum:
+  - DOCT
+  - MADM
+  - MISS
+  - MIST
+  - MIKS
+type: string
+example: DOCT

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

@@ -0,0 +1,4 @@
+title: Number
+type: string
+pattern: ^[\d\-\.\,]{1,18}$
+example: 256

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

@@ -0,0 +1,31 @@
+title: OrganisationIdentification29
+description: |
+  Unique and unambiguous way to identify an organisation.
+type: object
+properties:
+  AnyBIC:
+    description: >
+      AnyBIC
+
+      Business identification code of the organisation.
+    $ref: ./AnyBICDec2014Identifier.yaml
+  LEI:
+    description: >
+      LEI
+
+      Legal entity identification as an alternate identification for a party.
+    $ref: ./LEIIdentifier.yaml
+  Othr:
+    description: >
+      Other
+
+      Unique identification of an organisation, as assigned by an institution, using an identification scheme.
+    $ref: ./GenericOrganisationIdentification1.yaml
+example:
+  AnyBIC: BICFI
+  LEI: 529900T8BM49AURSDO55
+  Othr:
+    Id: 123
+    SchmeNm:
+      Cd: BIC
+    Issr: BIC