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

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

@@ -0,0 +1,16 @@
+title: ServiceLevel8Choice
+description: |
+  Details about a service level.
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalServiceLevel1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: SEPA

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

@@ -0,0 +1,40 @@
+title: SettlementInstruction15
+description: |
+  NOTE: Unsure on description.
+type: object
+properties:
+  SttlmMtd:
+    $ref: ./SettlementMethod1Code.yaml
+  PmtTpInf:
+    $ref: ./PaymentTypeInformation28.yaml
+required:
+  - SttlmMtd
+example:
+  SttlmMtd: INDA
+  PmtTpInf:
+    InstrPrty: NORM
+    SvcLvl:
+      Cd: SEPA
+    LclInstrm:
+      Cd: CH03
+    CtgyPurp:
+      Cd: SUPP
+    Cdtr:
+      Nm: Name
+      PstlAdr:
+        AdrTp: ADDR
+        AdrLine: Address
+        Ctry: CH
+      Id:
+        OrgId:
+          AnyBIC: BIC
+          Othr:
+            Id: 123
+            SchmeNm:
+              Cd: IBAN
+              Issr: BIC
+      CtryOfRes: CH
+      CtctDtls:
+        Nm: Name
+        PhneNb: 123
+        EmailAdr:

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

@@ -0,0 +1,10 @@
+title: SettlementMethod1Code
+description: |
+  Specifies the method used to settle the credit transfer instruction.
+type: string
+enum:
+  - INDA
+  - INGA
+  - COVE
+  - CLRG
+example: CLRG

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

@@ -0,0 +1,16 @@
+title: StatusReason6Choice
+description: |
+  Unsure on description.
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalStatusReason1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: AGNT

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

@@ -0,0 +1,27 @@
+title: StatusReasonInformation14
+description: |
+  Unsure on description.
+type: object
+properties:
+  Orgtr:
+    $ref: ./PartyIdentification272.yaml
+  Rsn:
+    $ref: ./StatusReason6Choice.yaml
+  AddtlInf:
+    $ref: ./Max105Text.yaml
+example:
+  Orgtr:
+    Nm: Name
+    PstlAdr:
+      AdrTp: ADDR
+      Dept: Department
+      SubDept: SubDepartment
+      StrtNm: StreetName
+      BldgNb: BuildingNumber
+      PstCd: PostCode
+      TwnNm: TownName
+      CtrySubDvsn: CountrySubDivision
+      Ctry: Country
+  Rsn:
+    Cd: AGNT
+  AddtlInf: AdditionalInformation

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

@@ -0,0 +1,26 @@
+title: StructuredRegulatoryReporting3
+description: |
+  Unsure on description.
+type: object
+properties:
+  Tp:
+    $ref: ./Max35Text.yaml
+  Dt:
+    $ref: ./ISODate.yaml
+  Ctry:
+    $ref: ./CountryCode.yaml
+  Cd:
+    $ref: ./Max10Text.yaml
+  Amt:
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  Inf:
+    $ref: ./Max35Text.yaml
+example:
+  Tp: T1
+  Dt: '2018-01-01'
+  Ctry: CH
+  Cd: CHF
+  Amt:
+    Ccy: CHF
+    Amt: 1000
+  Inf: 12345

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

@@ -0,0 +1,17 @@
+title: SupplementaryData1
+description: >
+  Additional information that can not be captured in the structured fields
+  and/or any other specific block.
+type: object
+properties:
+  PlcAndNm:
+    $ref: ./Max350Text.yaml
+  Envlp:
+    $ref: ./SupplementaryDataEnvelope1.yaml
+required:
+  - Envlp
+example:
+  PlcAndNm: Additional information
+  Envlp:
+    Cd: CH03
+    Prtry: Additional information

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

@@ -0,0 +1,5 @@
+title: SupplementaryDataEnvelope1
+description: |
+  Unsure on description.
+type: object
+

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

@@ -0,0 +1,29 @@
+title: TaxAmount3
+description: |
+  Information on the amount of the tax record.
+type: object
+properties:
+  Rate:
+    $ref: ./PercentageRate.yaml
+  TaxblBaseAmt:
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  TtlAmt:
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  Dtls:
+    $ref: ./TaxRecordDetails3.yaml
+example:
+  Rate: 0.0
+  TaxblBaseAmt:
+    Ccy: EUR
+    Amt: 0
+  TtlAmt:
+    Ccy: EUR
+    Amt: 0
+  Dtls:
+    Tp: T1
+    Ctry: CH
+    Cd: CHF
+    Amt:
+      Ccy: CHF
+      Amt: 1000
+    Inf: 12345

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

@@ -0,0 +1,12 @@
+title: TaxAuthorisation1
+description: |
+  Details of an authorised tax paying party.
+type: object
+properties:
+  Titl:
+    $ref: ./Max35Text.yaml
+  Nm:
+    $ref: ./Max140Text.yaml
+example:
+  Titl: Mr
+  Nm: John Doe

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

@@ -0,0 +1,57 @@
+title: TaxData1
+description: >
+  Details about tax paid, or to be paid, to the government in accordance with
+  the law, including pre-defined parameters such as thresholds and type of account.
+type: object
+properties:
+  Cdtr:
+    $ref: ./TaxParty1.yaml
+  Dbtr:
+    $ref: ./TaxParty2.yaml
+  UltmtDbtr:
+    $ref: ./TaxParty2.yaml
+  AdmstnZone:
+    $ref: ./Max35Text.yaml
+  RefNb:
+    $ref: ./Max140Text.yaml
+  Mtd:
+    $ref: ./Max35Text.yaml
+  TtlTaxblBaseAmt:
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  TtlTaxAmt:
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+  Dt:
+    $ref: ./ISODate.yaml
+  SeqNb:
+    $ref: ./Number.yaml
+  Rcrd:
+    $ref: ./TaxRecord3.yaml
+example:
+  Cdtr:
+    Titl: Mr
+    Nm: John Doe
+  Dbtr:
+    Titl: Mr
+    Nm: John Doe
+  UltmtDbtr:
+    Titl: Mr
+    Nm: John Doe
+  AdmstnZone: CH
+  RefNb: 12345
+  Mtd: A
+  TtlTaxblBaseAmt:
+    Ccy: CHF
+    Amt: 1000
+  TtlTaxAmt:
+    Ccy: CHF
+    Amt: 100
+  Dt: '2018-01-01'
+  SeqNb: 1
+  Rcrd:
+    Tp: T1
+    Ctry: CH
+    Cd: CHF
+    Amt:
+      Ccy: CHF
+      Amt: 1000
+    Inf: 12345

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

@@ -0,0 +1,15 @@
+title: TaxParty1
+description: |
+  Details about the entity involved in the tax paid or to be paid.
+type: object
+properties:
+  TaxId:
+    $ref: ./Max35Text.yaml
+  RegnId:
+    $ref: ./Max35Text.yaml
+  TaxTp:
+    $ref: ./Max35Text.yaml
+example:
+  TaxId: 123456789
+  RegnId: 123456789
+  TaxTp: VAT

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

@@ -0,0 +1,20 @@
+title: TaxParty2
+description: |
+  Details about the entity involved in the tax paid or to be paid.
+type: object
+properties:
+  TaxId:
+    $ref: ./Max35Text.yaml
+  RegnId:
+    $ref: ./Max35Text.yaml
+  TaxTp:
+    $ref: ./Max35Text.yaml
+  Authstn:
+    $ref: ./TaxAuthorisation1.yaml
+example:
+  TaxId: 123456789
+  RegnId: 123456789
+  TaxTp: VAT
+  Authstn:
+    Titl: Mr
+    Nm: John Doe

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

@@ -0,0 +1,17 @@
+title: TaxPeriod3
+description: |
+  Period of time details related to the tax payment.
+type: object
+properties:
+  Yr:
+    $ref: ./ISOYear.yaml
+  Tp:
+    $ref: ./TaxRecordPeriod1Code.yaml
+  FrToDt:
+    $ref: ./DatePeriod2.yaml
+example:
+  Yr: 2020
+  Tp: MM01
+  FrToDt:
+    FrDt: '2020-01-01'
+    ToDt: '2020-01-31'

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

@@ -0,0 +1,38 @@
+title: TaxRecord3
+description: |
+  Set of elements used to define the tax record.
+type: object
+properties:
+  Tp:
+    $ref: ./Max35Text.yaml
+  Ctgy:
+    $ref: ./Max35Text.yaml
+  CtgyDtls:
+    $ref: ./Max35Text.yaml
+  DbtrSts:
+    $ref: ./Max35Text.yaml
+  CertId:
+    $ref: ./Max35Text.yaml
+  FrmsCd:
+    $ref: ./Max35Text.yaml
+  Prd:
+    $ref: ./TaxPeriod3.yaml
+  TaxAmt:
+    $ref: ./TaxAmount3.yaml
+  AddtlInf:
+    $ref: ./Max140Text.yaml
+example:
+  Tp: VAT
+  Ctgy: A
+  CtgyDtls: Standard
+  DbtrSts: Resident
+  CertId: 123456789
+  FrmsCd: 123456789
+  Prd:
+    FrstDay: '2019-01-01'
+    LastDay: '2019-12-31'
+  TaxAmt:
+    Rate: 0.2
+    TaxblBaseAmt: 1000
+    TtlAmt: 200
+  AddtlInf: VAT applicable

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

@@ -0,0 +1,21 @@
+title: TaxRecordDetails3
+description: |
+  Details on the tax period and amount
+type: object
+properties:
+  Prd:
+    $ref: ./TaxPeriod3.yaml
+  Amt:
+    $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml
+required:
+  - Amt
+example:
+  Prd:
+    Yr: 2020
+    Tp: MM01
+    FrToDt:
+      FrDt: '2020-01-01'
+      ToDt: '2020-01-31'
+  Amt:
+    Amt: 100.00
+    Ccy: EUR

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

@@ -0,0 +1,43 @@
+title: TaxRecordPeriod1Code
+description: |
+  Specifies the period related to the tax payment
+
+  MM01 FirstMonth Tax is related to the second month of the period.
+  MM02 SecondMonth Tax is related to the first month of the period.
+  MM03 ThirdMonth Tax is related to the third month of the period.
+  MM04 FourthMonth Tax is related to the fourth month of the period.
+  MM05 FifthMonth Tax is related to the fifth month of the period.
+  MM06 SixthMonth Tax is related to the sixth month of the period.
+  MM07 SeventhMonth Tax is related to the seventh month of the period.
+  MM08 EighthMonth Tax is related to the eighth month of the period.
+  MM09 NinthMonth Tax is related to the ninth month of the period.
+  MM10 TenthMonth Tax is related to the tenth month of the period.
+  MM11 EleventhMonth Tax is related to the eleventh month of the period.
+  MM12 TwelfthMonth Tax is related to the twelfth month of the period.
+  QTR1 FirstQuarter Tax is related to the first quarter of the period.
+  QTR2 SecondQuarter Tax is related to the second quarter of the period.
+  QTR3 ThirdQuarter Tax is related to the third quarter of the period.
+  QTR4 FourthQuarter Tax is related to the forth quarter of the period.
+  HLF1 FirstHalf Tax is related to the first half of the period.
+  HLF2 SecondHalf Tax is related to the second half of the period.
+type: string
+enum:
+  - MM01
+  - MM02
+  - MM03
+  - MM04
+  - MM05
+  - MM06
+  - MM07
+  - MM08
+  - MM09
+  - MM10
+  - MM11
+  - MM12
+  - QTR1
+  - QTR2
+  - QTR3
+  - QTR4
+  - HLF1
+  - HLF2
+example: HLF1

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

@@ -0,0 +1,25 @@
+title: TermsRequest_FIToFICustomerCreditProposal
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader129.yaml
+required:
+  - GrpHdr
+example:
+  GrpHdr:
+    MsgId: 123456789
+    CreDtTm: '2020-01-01T00:00:00Z'
+    NbOfTxs: 1
+    CtrlSum: 100.00
+    InitgPty:
+      Nm: Initiating Party Name
+      Id:
+        OrgId:
+          Othr:
+            - Id: 123456789
+              SchmeNm:
+                Cd: BBA
+                Prtry: Party Identification Scheme Name
+    FwdgAgt:
+      FinInstnId:
+        BICFI: BBBBBBBB

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

@@ -0,0 +1,28 @@
+title: TermsResponse_FIToFICustomerCreditConfirmation
+type: object
+properties:
+  GrpHdr:
+    $ref: ./GroupHeader129.yaml
+  CdtTrfTxInf:
+    $ref: ./CreditTransferTransaction67.yaml
+required:
+  - GrpHdr
+  - CdtTrfTxInf
+example:
+  GrpHdr:
+    MsgId: 123456789
+    CreDtTm: '2020-01-01T00:00:00Z'
+    NbOfTxs: 1
+    CtrlSum: 100.00
+    InitgPty:
+      Nm: Initiating Party Name
+      Id:
+        OrgId:
+          Othr:
+            - Id: 123456789
+              SchmeNm:
+                Cd: BBA
+                Prtry: Party Identification Scheme Name
+    FwdgAgt:
+      FinInstnId:
+        BICFI: BBBBBBBB

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

@@ -0,0 +1,4 @@
+title: UUIDv4Identifier
+type: string
+pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
+example: 8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e

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

@@ -0,0 +1,14 @@
+title: VerificationReason1Choice
+type: object
+properties:
+  Cd:
+    $ref: ./ExternalVerificationReason1Code.yaml
+  Prtry:
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: AGNT

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

@@ -0,0 +1,29 @@
+title: VerificationReport4
+type: object
+properties:
+  OrgnlId:
+    $ref: ./Max35Text.yaml
+  Vrfctn:
+    $ref: ./IdentificationVerificationIndicator.yaml
+  Rsn:
+    $ref: ./VerificationReason1Choice.yaml
+  OrgnlPtyAndAcctId:
+    $ref: ./IdentificationInformation4.yaml
+  UpdtdPtyAndAcctId:
+    $ref: ./IdentificationInformation4.yaml
+required:
+  - OrgnlId
+  - Vrfctn
+example:
+  OrgnlId: 123456789
+  Vrfctn: true
+  Rsn:
+    Cd: AGNT
+  OrgnlPtyAndAcctId:
+    Id: 123456789
+    SchmeNm:
+      Cd: CCPT
+  UpdtdPtyAndAcctId:
+    Id: 123456789
+    SchmeNm:
+      Cd: CCPT

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

@@ -0,0 +1,4 @@
+title: hexBinary
+type: string
+pattern: ^(0x|0X)?[a-fA-F0-9]+$
+example: 0x1234

package/fspiop/v2_0_ISO20022/openapi3/openapi.yaml

@@ -0,0 +1,53 @@
+openapi: 3.0.2
+info:
+  version: v2.0-iso20022-draft
+  title: Open API for FSP Interoperability (FSPIOP) - the ISO 20022 message version
+  description: >-
+    IN PROGRESS
+  license:
+    name: CC BY-ND 4.0
+    url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
+  contact:
+    name: Sam Kummary
+    url: https://github.com/mojaloop/mojaloop-specification/issues
+servers:
+  - url: 'protocol://hostname:<port>/switch/'
+    variables:
+      protocol:
+        enum:
+          - http
+          - https
+        default: https
+paths:
+  /parties/{Type}/{ID}:
+    $ref: paths/parties_{Type}_{ID}.yaml
+  /parties/{Type}/{ID}/error:
+    $ref: paths/parties_{Type}_{ID}_error.yaml
+  /parties/{Type}/{ID}/{SubId}:
+    $ref: paths/parties_{Type}_{ID}_{SubId}.yaml
+  /parties/{Type}/{ID}/{SubId}/error:
+    $ref: paths/parties_{Type}_{ID}_{SubId}_error.yaml
+  /quotes:
+    $ref: paths/quotes.yaml
+  /quotes/{ID}:
+    $ref: paths/quotes_{ID}.yaml
+  /quotes/{ID}/error:
+    $ref: paths/quotes_{ID}_error.yaml
+  /transfers:
+    $ref: paths/transfers.yaml
+  /transfers/{ID}:
+    $ref: paths/transfers_{ID}.yaml
+  /transfers/{ID}/error:
+    $ref: paths/transfers_{ID}_error.yaml
+  /fxQuotes:
+    $ref: paths/fxQuotes.yaml
+  /fxQuotes/{ID}:
+    $ref: paths/fxQuotes_{ID}.yaml
+  /fxQuotes/{ID}/error:
+    $ref: paths/fxQuotes_{ID}_error.yaml
+  /fxTransfers:
+    $ref: paths/fxTransfers.yaml
+  /fxTransfers/{ID}:
+    $ref: paths/fxTransfers_{ID}.yaml
+  /fxTransfers/{ID}/error:
+    $ref: paths/fxTransfers_{ID}_error.yaml

package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes.yaml

@@ -0,0 +1,46 @@
+post:
+  description: >-
+    The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a
+    quotation for a currency conversion.
+  summary: Calculate FX quote
+  tags:
+    - fxQuotes
+  operationId: FxQuotesPost
+  parameters:
+    - $ref: ../components/parameters/Accept.yaml
+    - $ref: ../components/parameters/Content-Length.yaml
+    - $ref: ../components/parameters/Content-Type.yaml
+    - $ref: ../components/parameters/Date.yaml
+    - $ref: ../components/parameters/X-Forwarded-For.yaml
+    - $ref: ../components/parameters/FSPIOP-Source.yaml
+    - $ref: ../components/parameters/FSPIOP-Destination.yaml
+    - $ref: ../components/parameters/FSPIOP-Encryption.yaml
+    - $ref: ../components/parameters/FSPIOP-Signature.yaml
+    - $ref: ../components/parameters/FSPIOP-URI.yaml
+    - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
+  requestBody:
+    description: Details of the FX quote to be created.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/FxRequest_FICreditTransferProposal.yaml
+  responses:
+    '202':
+      $ref: ../components/responses/202.yaml
+    '400':
+      $ref: ../components/responses/400.yaml
+    '401':
+      $ref: ../components/responses/401.yaml
+    '403':
+      $ref: ../components/responses/403.yaml
+    '404':
+      $ref: ../components/responses/404.yaml
+    '405':
+      $ref: ../components/responses/405.yaml
+    '406':
+      $ref: ../components/responses/406.yaml
+    '501':
+      $ref: ../components/responses/501.yaml
+    '503':
+      $ref: ../components/responses/503.yaml