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

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

@@ -0,0 +1,27 @@
+title: TaxParty1
+description: |
+  Details about the entity involved in the tax paid or to be paid.
+type: object
+properties:
+  TaxId:
+    description: |
+      TaxIdentification
+
+      Tax identification number of the creditor.
+    $ref: ./Max35Text.yaml
+  RegnId:
+    description: |
+      RegistrationIdentification
+
+      Unique identification, as assigned by an organisation, to unambiguously identify a party.
+    $ref: ./Max35Text.yaml
+  TaxTp:
+    description: |
+      TaxType
+
+      Type of tax payer.
+    $ref: ./Max35Text.yaml
+example:
+  TaxId: 123456789
+  RegnId: 123456789
+  TaxTp: VAT

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

@@ -0,0 +1,36 @@
+title: TaxParty2
+description: |
+  Details about the entity involved in the tax paid or to be paid.
+type: object
+properties:
+  TaxId:
+    description: |
+      TaxIdentification
+
+      Tax identification number of the debtor.
+    $ref: ./Max35Text.yaml
+  RegnId:
+    description: |
+      RegistrationIdentification
+
+      Unique identification, as assigned by an organisation, to unambiguously identify a party.
+    $ref: ./Max35Text.yaml
+  TaxTp:
+    description: |
+      TaxType
+
+      Type of tax payer.
+    $ref: ./Max35Text.yaml
+  Authstn:
+    description: |
+      Authorisation
+
+      Details of the authorised tax paying party.
+    $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,29 @@
+title: TaxPeriod3
+description: |
+  Period of time details related to the tax payment.
+type: object
+properties:
+  FrToDt:
+    $ref: ./DatePeriod2.yaml
+    description: |
+      FromToDate
+
+      Range of time between a start date and an end date for which the tax report is provided.
+  Tp:
+    $ref: ./TaxRecordPeriod1Code.yaml
+    description: |
+      Type
+
+      Identification of the period related to the tax payment.
+  Yr:
+    $ref: ./ISOYear.yaml
+    description: |
+      Year
+
+      Year related to the tax payment.
+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,74 @@
+title: TaxRecord3
+description: |
+  Set of elements used to define the tax record.
+type: object
+properties:
+  AddtlInf:
+    $ref: ./Max140Text.yaml
+    description: |
+      AdditionalInformation
+
+      Further details of the tax record.
+  CertId:
+    $ref: ./Max35Text.yaml
+    description: |
+      CertificateIdentification
+
+      Identification number of the tax report as assigned by the taxing authority.
+  Ctgy:
+    $ref: ./Max35Text.yaml
+    description: |
+      Category
+
+      Specifies the tax code as published by the tax authority.
+  CtgyDtls:
+    $ref: ./Max35Text.yaml
+    description: |
+      CategoryDetails
+
+      Provides further details of the category tax code.
+  DbtrSts:
+    $ref: ./Max35Text.yaml
+    description: |
+      DebtorStatus
+
+      Code provided by local authority to identify the status of the party that has drawn up the settlement document.
+  FrmsCd:
+    $ref: ./Max35Text.yaml
+    description: |
+      FormsCode
+
+      Identifies, in a coded form, on which template the tax report is to be provided.
+  Prd:
+    $ref: ./TaxPeriod3.yaml
+    description: |
+      Period
+
+      Set of elements used to provide details on the period of time related to the tax payment.
+  TaxAmt:
+    $ref: ./TaxAmount3.yaml
+    description: |
+      TaxAmount
+
+      Set of elements used to provide information on the amount of the tax record.
+  Tp:
+    $ref: ./Max35Text.yaml
+    description: |
+      Type
+
+      High level code to identify the type of tax details.
+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,29 @@
+title: TaxRecordDetails3
+description: |
+  Details on the tax period and amount
+type: object
+properties:
+  Prd:
+    description: |
+      Period
+
+      Set of elements used to provide details on the period of time related to the tax payment.
+    $ref: ./TaxPeriod3.yaml
+  Amt:
+    description: |
+      Amount
+
+      Underlying tax amount related to the specified period.
+    $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,23 @@
+title: VerificationReason1Choice
+type: object
+properties:
+  Cd:
+    description: >
+      Code
+
+      Reason why the verified identification information is incorrect, as published in an external
+      reason code list.
+    $ref: ./ExternalVerificationReason1Code.yaml
+  Prtry:
+    description: >
+      Proprietary
+
+      Reason why the verified identification information is incorrect, in a free text form.
+    $ref: ./Max35Text.yaml
+oneOf:
+  - required:
+      - Cd
+  - required:
+      - Prtry
+example:
+  Cd: AGNT

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

@@ -0,0 +1,77 @@
+title: VerificationReport4
+type: object
+properties:
+  OrgnlId:
+    description: >
+      OriginalIdentification
+
+      Unique identification, as assigned by a sending party, to unambiguously identify the party
+      and account identification information group within the original message.
+    $ref: ./Max35Text.yaml
+  Vrfctn:
+    description: >
+      Verification
+
+      Identifies whether the party and/or account information received is correct.
+      Boolean value.
+    $ref: ./IdentificationVerificationIndicator.yaml
+  Rsn:
+    description: >
+      Reason.
+
+      Specifies the reason why the verified identification information is incorrect.
+    $ref: ./VerificationReason1Choice.yaml
+  OrgnlPtyAndAcctId:
+    description: >
+      OriginalPartyAndAccountIdentification
+
+      Provides party and/or account identification information as given in the original message.
+    $ref: ./IdentificationInformation4.yaml
+  UpdtdPtyAndAcctId:
+    description: >
+      UpdatedPartyAndAccountIdentification
+
+      Provides party and/or account identification information.
+    $ref: ./IdentificationInformation4.yaml
+required:
+  - OrgnlId
+  - Vrfctn
+example:
+  OrgnlId: 1234567890123456789012345678901234
+  Vrfctn: true
+  OrgnlPtyAndAcctId:
+    Nm: John Doe
+    PstlAdr:
+      AdrTp: ADDR
+      Dept: Dept
+      SubDept: SubDept
+      StrtNm: 1234 Elm St
+      BldgNb: 1234
+      PstCd: 12345
+      TwnNm: Anytown
+      CtrySubDvsn: CA
+      Ctry: US
+    Id:
+      OrgId:
+        AnyBIC: ABCDUS33
+        Othr:
+          Id: 123456789
+          Issr: ABA
+  UpdtdPtyAndAcctId:
+    Nm: John Doe
+    PstlAdr:
+      AdrTp: ADDR
+      Dept: Dept
+      SubDept: SubDept
+      StrtNm: 1234 Elm St
+      BldgNb: 1234
+      PstCd: 12345
+      TwnNm: Anytown
+      CtrySubDvsn: CA
+      Ctry: US
+    Id:
+      OrgId:
+        AnyBIC: ABCDUS33
+        Othr:
+          Id: 123456789
+          Issr: ABA

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.1.0
+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

package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}.yaml

@@ -0,0 +1,81 @@
+parameters:
+  - $ref: ../components/parameters/ID.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
+get:
+  description: >-
+    The HTTP request `GET /fxQuotes/{ID}` is used to request information
+    regarding a request for quotation for a  currency conversion which the
+    sender has previously issued. The `{ID}` in the URI should contain the
+    `conversionRequestId` that was used for the creation of the quote.
+  summary: Retrieve FX quote information
+  tags:
+    - fxQuotes
+  operationId: FxQuotesByIDGet
+  parameters:
+    - $ref: ../components/parameters/Accept.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
+put:
+  description: >-
+    The callback `PUT /fxQuotes/{ID}` is used to inform the requester about the
+    outcome of a request for quotation for a currency conversion.  The `{ID}` in
+    the URI should contain the `conversionRequestId` that was used for the
+    creation of the FX quote, or the `{ID}` that was used in the `GET
+    /fxQuotes/{ID}` request.
+  summary: Return FX quote information
+  tags:
+    - fxQuotes
+  operationId: FxQuotesByIdPut
+  parameters:
+    - $ref: ../components/parameters/Content-Length.yaml
+  requestBody:
+    description: FX Quote information returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/FxResponse_FICreditTransferConfirmation.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.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

package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}_error.yaml

@@ -0,0 +1,49 @@
+put:
+  description: >-
+    If the FXP is unable to find or create a FX quote, or some other processing
+    error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The
+    `{ID}` in the URI should contain the `conversionRequestId` that was used for
+    the creation of the FX quote, or the `{ID}` that was used in the `GET
+    /fxQuotes/{ID}` request.
+  summary: Return FX quote information error
+  tags:
+    - fxQuotes
+  operationId: FxQuotesByIDAndErrorPut
+  parameters:
+    - $ref: ../components/parameters/ID.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 error returned.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: ../components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml
+  responses:
+    '200':
+      $ref: ../components/responses/200.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

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

@@ -0,0 +1,47 @@
+post:
+  description: >-
+    The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the
+    execution of an agreed currency conversion.
+  summary: Perform FX transfer
+  tags:
+    - fxTransfers
+  operationId: FxTransfersPost
+  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 transfer to be created.
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: >-
+            ../components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.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