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

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

@@ -0,0 +1,31 @@
+title: OrganisationIdentification39
+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: ./GenericOrganisationIdentification3.yaml
+example:
+  AnyBIC: BICFI
+  LEI: 529900T8BM49AURSDO55
+  Othr:
+    Id: 123
+    SchmeNm:
+      Cd: BIC
+    Issr: BIC

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

@@ -0,0 +1,24 @@
+title: OrganisationIdentificationSchemeName1Choice
+description: |
+  Choice of format for the organisation identification.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Name of the identification scheme, in a coded form as published in an external list.
+    $ref: ./ExternalOrganisationIdentification1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Name of the identification scheme, in a free text form.
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: BIC

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

@@ -0,0 +1,22 @@
+title: OtherContact1
+description: |
+  Communication device number or electronic address used for communication.
+type: object
+properties:
+  ChanlTp:
+    description: >
+      ChannelType
+
+      Method used to contact the financial institution's contact for the specific tax region.
+    $ref: ./Max4Text.yaml
+  Id:
+    description: >
+      Identifier
+
+      Communication value such as phone number or email address.
+    $ref: ./Max128Text.yaml
+required:
+  - ChanlTp
+example:
+  ChanlTp: PHON
+  Id: 1234567890

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

@@ -0,0 +1,35 @@
+title: PacsError_FIToFIPaymentStatusReportV15
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader120.yaml
+  TxInfAndSts:
+    $ref: ./PaymentTransaction163.yaml
+  SplmtryData:
+    $ref: ./SupplementaryData1.yaml
+required:
+  - GrpHdr
+example:
+  GrpHdr:
+    MsgId: 12345
+    CreDtTm: '2020-01-01T00:00:00Z'
+    NbOfTxs: 1
+    SttlmInf:
+      SttlmMtd: INDA
+      SttlmDt: '2020-01-01'
+    InstgAgt:
+      FinInstnId:
+        BICFI: BICFI
+    InstdAgt:
+      FinInstnId:
+        BICFI: BICFI
+  TxInfAndSts:
+    OrgnlInstrId: 12345
+    OrgnlEndToEndId: 12345
+    TxSts: RJCT
+    StsRsnInf:
+      Rsn: RSN
+      AddtlInf: ADDITIONAL
+  SplmtryData:
+    PlcAndNm: PLACE
+    Envlp: ENVELOPE

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

@@ -0,0 +1,30 @@
+title: PacsStatus_FIToFIPaymentStatusReportV15
+description: |
+  Unsure on description.
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader120.yaml
+required:
+  - GrpHdr
+example:
+  GrpHdr:
+    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/Party38Choice.yaml

@@ -0,0 +1,29 @@
+title: Party38Choice
+description: |
+  Nature or use of the account.
+type: object
+properties:
+  OrgId:
+    description: >
+      Organisation
+
+      Unique and unambiguous way to identify an organisation.
+    $ref: ./OrganisationIdentification29.yaml
+  PrvtId:
+    description: >
+      PrivateIdentification
+
+      Unique and unambiguous identification of a person, for example a passport.
+    $ref: ./PersonIdentification13.yaml
+oneOf:
+  - required:
+      - OrgId
+  - required:
+      - PrvtId
+example:
+  OrgId:
+    AnyBIC: BIC
+  PrvtId:
+    DtAndPlcOfBirth:
+      Dt: '2018-01-01'
+      CityOfBirth: City

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

@@ -0,0 +1,45 @@
+title: Party40Choice
+description: |
+   Identification of a person, an organisation or a financial institution.
+type: object
+properties:
+  Pty:
+    description: >
+      Party
+
+      Identification of a person or an organisation.
+    $ref: ./PartyIdentification135.yaml
+  Agt:
+    description: >
+      Agent
+
+      Identification of a financial institution.
+    $ref: ./BranchAndFinancialInstitutionIdentification6.yaml
+oneOf:
+  - required:
+      - Pty
+  - required:
+      - Agt
+example:
+  Pty:
+    Nm: Name
+    PstlAdr:
+      Ctry: US
+      AdrLine:
+        - Line1
+        - Line2
+    Id:
+      OrgId:
+        AnyBIC: BIC
+  Agt:
+    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/Party52Choice.yaml

@@ -0,0 +1,29 @@
+title: Party52Choice
+description: |
+  NOTE: Unsure on the description.
+type: object
+properties:
+  OrgId:
+    description: >
+      Organisation
+
+      Unique and unambiguous way to identify an organisation.
+    $ref: ./OrganisationIdentification39.yaml
+  PrvtId:
+    description: >
+      Person
+
+      Unique and unambiguous identification of a person, for example a passport
+    $ref: ./PersonIdentification18.yaml
+oneOf:
+  - required:
+      - OrgId
+  - required:
+      - PrvtId
+example:
+  OrgId:
+    AnyBIC: BIC
+  PrvtId:
+    DtAndPlcOfBirth:
+      Dt: '2018-01-01'
+      CityOfBirth: City

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

@@ -0,0 +1,70 @@
+title: PartyIdentification135
+description: |
+  Specifies the identification of a person or an organisation.
+type: object
+properties:
+  Nm:
+    description: >
+      Name
+
+      Name by which a party is known and which is usually used to identify that party.
+    $ref: ./Max140Text.yaml
+  PstlAdr:
+    description: >
+      PostalAddress
+
+      Information that locates and identifies a specific address, as defined by postal services.
+    $ref: ./PostalAddress24.yaml
+  Id:
+    description: >
+      Identification
+
+      Unique and unambiguous way to identify an organisation.
+    $ref: ./Party38Choice.yaml
+  CtryOfRes:
+    description: >
+      CountryOfResidence
+      Country in which a person resides (the place of a person's home). In the case of a company,
+      it is the country from which the affairs of that company are directed.
+    $ref: ./CountryCode.yaml
+  CtctDtls:
+    description: >
+      ContactDetails
+
+      Set of elements used to indicate how to contact the party.
+    $ref: ./Contact4.yaml
+example:
+  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: 123
+        SchmeNm:
+          Prtry: DfspId
+
+  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/PartyIdentification272.yaml

@@ -0,0 +1,63 @@
+title: PartyIdentification272
+description: |
+  Specifies the identification of a person or an organisation.
+type: object
+properties:
+  Nm:
+    description: >
+      Name
+
+      Name by which a party is known and which is usually used to identify that party.
+    $ref: ./Max140Text.yaml
+  PstlAdr:
+    description: >
+      Postal Address
+
+      Information that locates and identifies a specific address, as defined by postal services.
+    $ref: ./PostalAddress27.yaml
+  Id:
+    description: >
+      Identification
+
+      Unique and unambiguous identification of a party.
+    $ref: ./Party52Choice.yaml
+  CtryOfRes:
+    description: >
+      Country of Residence
+
+      Country in which a person resides (the place of a person's home).
+      In the case of a company, it is the country from which the affairs of that company are directed.
+    $ref: ./CountryCode.yaml
+  CtctDtls:
+    description: >
+      Contact Details
+
+      Set of elements used to indicate how to contact the party.
+    $ref: ./Contact13.yaml
+example:
+  Nm: John Doe
+  PstlAdr:
+    AdrTp: ADDR
+    Dept: Dept
+    SubDept: SubDept
+    StrtNm: StrtNm
+    BldgNb: BldgNb
+    PstCd: PstCd
+    TwnNm: TwnNm
+    CtrySubDvsn: CtrySubDvsn
+    Ctry: Ctry
+  Id:
+    OrgId:
+      AnyBIC: BIC
+    PrvtId:
+      DtAndPlcOfBirth:
+        Dt: '2018-01-01'
+        CityOfBirth: City
+  CtryOfRes: BE
+  CtctDtls:
+    NmPrfx: Mr
+    Nm: John Doe
+    PhneNb: +123-123-321
+    MobNb: +123-123-321
+    FaxNb: +123-123-321
+    EmailAdr:

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

@@ -0,0 +1,62 @@
+title: PaymentIdentification13
+description: |
+  Provides further means of referencing a payment transaction.
+type: object
+properties:
+  InstrId:
+    description: >
+      InstructionIdentification
+
+      Definition: Unique identification, as assigned by an instructing party for an instructed party, to
+      unambiguously identify the instruction.
+
+      Usage: The instruction identification is a point to point reference that can be used between the
+      instructing party and the instructed party to refer to the individual instruction. It can be included in
+      several messages related to the instruction.
+    $ref: ./Max35Text.yaml
+  EndToEndId:
+    description: >
+      EndToEndIdentification
+
+      Definition: Unique identification, as assigned by the initiating party, to unambiguously identify the
+      transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
+
+      Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the
+      transaction. It can be included in several messages related to the transaction.
+
+      Usage: In case there are technical limitations to pass on multiple references, the end-to-end
+      identification must be passed on throughout the entire end-to-end chain.
+    $ref: ./Max35Text.yaml
+  TxId:
+    description: >
+      TransactionIdentification
+
+      Definition: Unique identification, as assigned by the first instructing agent, to unambiguously identify the
+      transaction that is passed on, unchanged, throughout the entire interbank chain.
+
+      Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to
+      the transaction on the interbank level.
+
+      Usage: The instructing agent has to make sure that the transaction identification is unique for a preagreed period.
+    $ref: ./Max35Text.yaml
+  UETR:
+    description: >
+      UETR
+
+      Universally unique identifier to provide an end-to-end reference of a payment transaction.
+    $ref: ./UUIDv4Identifier.yaml
+  ClrSysRef:
+    description: >
+      ClearingSystemReference
+
+      Unique reference, as assigned by a clearing system, to unambiguously identify the
+      instruction.
+    $ref: ./Max35Text.yaml
+required:
+  - EndToEndId
+example:
+  InstrId: INSTRUCTIONID
+  EndToEndId: ENDTOENDID
+  TxId: TRANSACTIONID
+  UETR: 123e4567-e89b-12d3-a456-426614174000
+  ClrSysRef: CLRSYSREF

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

@@ -0,0 +1,47 @@
+title: PaymentTransaction163
+description: >
+  Provides further details on the original transactions, to which the status
+  report message refers.
+type: object
+properties:
+  StsId:
+    $ref: ./Max35Text.yaml
+  OrgnlInstrId:
+    $ref: ./Max35Text.yaml
+  OrgnlEndToEndId:
+    $ref: ./Max35Text.yaml
+  OrgnlTxId:
+    $ref: ./Max35Text.yaml
+  OrgnlUETR:
+    $ref: ./UUIDv4Identifier.yaml
+  TxSts:
+    $ref: ./ExternalPaymentTransactionStatus1Code.yaml
+  StsRsnInf:
+    $ref: ./StatusReasonInformation14.yaml
+  AccptncDtTm:
+    $ref: ./ISODateTime.yaml
+  AcctSvcrRef:
+    $ref: ./Max35Text.yaml
+  ClrSysRef:
+    $ref: ./Max35Text.yaml
+  ExctnConf:
+    $ref: ./Exact32HexBinaryText.yaml
+  SplmtryData:
+    $ref: ./SupplementaryData1.yaml
+example:
+  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/PaymentTypeInformation28.yaml

@@ -0,0 +1,48 @@
+title: PaymentTypeInformation28
+description: |
+  Provides further details of the type of payment.
+type: object
+properties:
+  InstrPrty:
+    description: >
+      InstructionPriority
+
+      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.
+    $ref: ./Priority2Code.yaml
+  ClrChanl:
+    description: >
+      ClearingChannel
+
+      Specifies the clearing channel to be used to process the payment instruction.
+    $ref: ./ClearingChannel2Code.yaml
+  SvcLvl:
+    description: >
+      ServiceLevel
+
+      Agreement under which or rules under which the transaction should be processed.
+    $ref: ./ServiceLevel8Choice.yaml
+  LclInstrm:
+    description: >
+      LocalInstrument
+
+      Definition: User community specific instrument.
+
+      Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the
+      service or service level.
+    $ref: ./LocalInstrument2Choice.yaml
+  CtgyPurp:
+    description: >
+      CategoryPurpose
+
+      Specifies the high level purpose of the instruction based on a set of pre-defined categories.
+    $ref: ./CategoryPurpose1Choice.yaml
+example:
+  InstrPrty: NORM
+  ClrChanl: RTGS
+  SvcLvl:
+    Cd: SEPA
+  LclInstrm:
+    Cd: CORE
+  CtgyPurp:
+    Cd: CASH

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

@@ -0,0 +1,4 @@
+title: PercentageRate
+type: string
+pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$
+example: 1234

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

@@ -0,0 +1,26 @@
+title: PersonIdentification13
+description: |
+  Unique and unambiguous way to identify a person.
+type: object
+properties:
+  DtAndPlcOfBirth:
+    description: >
+      DateAndPlaceOfBirth
+
+      Date and place of birth of a person.
+    $ref: ./DateAndPlaceOfBirth1.yaml
+  Othr:
+    description: >
+      Other
+
+      Unique identification of a person, as assigned by an institution, using an identification scheme.
+    $ref: ./GenericPersonIdentification1.yaml
+example:
+  DtAndPlcOfBirth:
+    Dt: '2018-01-01'
+    CityOfBirth: City
+  Othr:
+    Id: 123
+    SchmeNm:
+      Cd: CUST
+      Prtry: 1

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

@@ -0,0 +1,26 @@
+title: PersonIdentification18
+description: |
+  Unique and unambiguous way to identify a person.
+type: object
+properties:
+  DtAndPlcOfBirth:
+    description: >
+      DateAndPlaceOfBirth
+
+      Date and place of birth of a person.
+    $ref: ./DateAndPlaceOfBirth1.yaml
+  Othr:
+    description: >
+      Other
+
+      Unique identification of a person, as assigned by an institution, using an identification scheme.
+    $ref: ./GenericPersonIdentification2.yaml
+example:
+  DtAndPlcOfBirth:
+    Dt: '2018-01-01'
+    CityOfBirth: City
+  Othr:
+    Id: 123
+    SchmeNm:
+      Cd: CUST
+      Prtry: 1

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

@@ -0,0 +1,24 @@
+title: PersonIdentificationSchemeName1Choice
+description: |
+  Sets of elements to identify a name of the identification scheme.
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Name of the identification scheme, in a coded form as published in an external list
+    $ref: ./ExternalPersonIdentification1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Name of the identification scheme, in a free text form
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: CCPT

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

@@ -0,0 +1,5 @@
+title: PhoneNumber
+type: string
+description: |
+  Double check this regex.
+pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$

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

@@ -0,0 +1,55 @@
+title: PostalAddress24
+type: object
+description: >
+  Information that locates and identifies a specific address, as defined by
+  postal services.
+properties:
+  AdrTp:
+    $ref: ./AddressType3Choice.yaml
+  Dept:
+    $ref: ./Max70Text.yaml
+  SubDept:
+    $ref: ./Max70Text.yaml
+  StrtNm:
+    $ref: ./Max70Text.yaml
+  BldgNb:
+    $ref: ./Max16Text.yaml
+  BldgNm:
+    $ref: ./Max35Text.yaml
+  Flr:
+    $ref: ./Max70Text.yaml
+  PstBx:
+    $ref: ./Max16Text.yaml
+  Room:
+    $ref: ./Max70Text.yaml
+  PstCd:
+    $ref: ./Max16Text.yaml
+  TwnNm:
+    $ref: ./Max35Text.yaml
+  TwnLctnNm:
+    $ref: ./Max35Text.yaml
+  DstrctNm:
+    $ref: ./Max35Text.yaml
+  CtrySubDvsn:
+    $ref: ./Max35Text.yaml
+  Ctry:
+    $ref: ./CountryCode.yaml
+  AdrLine:
+    $ref: ./Max70Text.yaml
+example:
+  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