@mojaloop/api-snippets 17.6.0-snapshot.0 → 17.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/audit-ci.jsonc +2 -1
- package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +1 -1
- package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +1 -1
- package/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +4735 -0
- package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +1 -1
- package/docs/index.html +1 -0
- package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +7 -7
- package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +7 -7
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1 -1
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +1 -1
- package/docs/thirdparty-openapi3-snippets.yaml +1 -1
- package/fspiop/v1_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyCode.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyCode.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AnyBICDec2014Identifier.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BICFIDec2014Identifier.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml +39 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml +36 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml +125 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml +69 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorCode.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorDescription.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformation.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformationResponse.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact4AlphaNumericText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml +61 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Extension.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionKey.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionList.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionValue.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalAccountIdentification1Code.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCashAccountType1Code.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCategoryPurpose1Code.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml +83 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml +81 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml +72 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml +35 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml +58 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODate.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISOYear.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml +33 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml +3 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LEIIdentifier.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max105Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max10Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max128Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max140Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max15NumericText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max16Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max2048Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max256Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max34Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max350Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max35Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max4Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max70Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml +19 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml +19 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml +35 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml +79 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml +37 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml +34 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml +42 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml +18 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml +18 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PhoneNumber.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml +55 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml +61 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml +19 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml +40 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml +27 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml +20 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml +38 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml +43 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/openapi.yaml +53 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}.yaml +81 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml +120 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}.yaml +82 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_error.yaml +50 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}.yaml +83 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}_error.yaml +51 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}.yaml +80 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml +119 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}_error.yaml +49 -0
- package/lib/fspiop/v1_0/openapi.d.ts +1494 -409
- package/lib/fspiop/v1_1/openapi.d.ts +1495 -417
- package/lib/fspiop/v2_0/json-schemas.json +39 -39
- package/lib/fspiop/v2_0/openapi.d.ts +1945 -560
- package/lib/fspiop/v2_0_ISO20022/index.d.ts +3 -0
- package/lib/fspiop/v2_0_ISO20022/index.js +9 -0
- package/lib/fspiop/v2_0_ISO20022/index.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/json-schemas.json +107991 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.d.ts +5162 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.js +7 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.d.ts +95738 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.js +171 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/types.d.ts +164 -0
- package/lib/fspiop/v2_0_ISO20022/types.js +4 -0
- package/lib/fspiop/v2_0_ISO20022/types.js.map +1 -0
- package/lib/index.d.ts +3 -0
- package/lib/index.js +4 -1
- package/lib/index.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +55 -55
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +384 -74
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +55 -55
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +543 -109
- package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +66 -66
- package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +503 -139
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +72 -72
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +694 -184
- package/lib/thirdparty/openapi.d.ts +1639 -612
- package/package.json +30 -27
- package/sdk-bulk.yaml +1 -1
- package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml +6 -6
- package/sdk-scheme-adapter/v2_0_0/components/schemas/CorrelationId.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +6 -6
- package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml +1 -1
@@ -4,90 +4,291 @@
|
|
4
4
|
*/
|
5
5
|
export interface paths {
|
6
6
|
"/": {
|
7
|
+
parameters: {
|
8
|
+
query?: never;
|
9
|
+
header?: never;
|
10
|
+
path?: never;
|
11
|
+
cookie?: never;
|
12
|
+
};
|
7
13
|
/** Health check endpoint. */
|
8
14
|
get: operations["BackendHealthCheck"];
|
15
|
+
put?: never;
|
16
|
+
post?: never;
|
17
|
+
delete?: never;
|
18
|
+
options?: never;
|
19
|
+
head?: never;
|
20
|
+
patch?: never;
|
21
|
+
trace?: never;
|
9
22
|
};
|
10
23
|
"/bulkQuotes": {
|
24
|
+
parameters: {
|
25
|
+
query?: never;
|
26
|
+
header?: never;
|
27
|
+
path?: never;
|
28
|
+
cookie?: never;
|
29
|
+
};
|
30
|
+
get?: never;
|
31
|
+
put?: never;
|
11
32
|
/** Requests a bulk quote. */
|
12
33
|
post: operations["BackendBulkQuotesPost"];
|
34
|
+
delete?: never;
|
35
|
+
options?: never;
|
36
|
+
head?: never;
|
37
|
+
patch?: never;
|
38
|
+
trace?: never;
|
13
39
|
};
|
14
40
|
"/bulkQuotes/{idValue}": {
|
41
|
+
parameters: {
|
42
|
+
query?: never;
|
43
|
+
header?: never;
|
44
|
+
path?: never;
|
45
|
+
cookie?: never;
|
46
|
+
};
|
15
47
|
/** Requests information relating to a bulk quote identified by the specified identifier value. */
|
16
48
|
get: operations["BackendBulkQuotesGet"];
|
49
|
+
put?: never;
|
50
|
+
post?: never;
|
51
|
+
delete?: never;
|
52
|
+
options?: never;
|
53
|
+
head?: never;
|
54
|
+
patch?: never;
|
55
|
+
trace?: never;
|
17
56
|
};
|
18
57
|
"/bulkTransactions/{bulkTransactionId}": {
|
58
|
+
parameters: {
|
59
|
+
query?: never;
|
60
|
+
header?: never;
|
61
|
+
path?: never;
|
62
|
+
cookie?: never;
|
63
|
+
};
|
64
|
+
get?: never;
|
19
65
|
/**
|
20
66
|
* Callbacks for the bulk transaction request.
|
21
67
|
* @description The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
|
22
68
|
*/
|
23
69
|
put: operations["BackendBulkTransactionsPut"];
|
70
|
+
post?: never;
|
71
|
+
delete?: never;
|
72
|
+
options?: never;
|
73
|
+
head?: never;
|
74
|
+
patch?: never;
|
75
|
+
trace?: never;
|
24
76
|
};
|
25
77
|
"/requestToPay/{transactionRequestId}": {
|
78
|
+
parameters: {
|
79
|
+
query?: never;
|
80
|
+
header?: never;
|
81
|
+
path?: never;
|
82
|
+
cookie?: never;
|
83
|
+
};
|
84
|
+
get?: never;
|
26
85
|
/**
|
27
86
|
* Callback for the requestToPay request.
|
28
87
|
* @description It is used to notify the DFSP backend about the status of the requestToPayTransfer.
|
29
88
|
*/
|
30
89
|
put: operations["RequestToPayPut"];
|
90
|
+
post?: never;
|
91
|
+
delete?: never;
|
92
|
+
options?: never;
|
93
|
+
head?: never;
|
94
|
+
patch?: never;
|
95
|
+
trace?: never;
|
31
96
|
};
|
32
97
|
"/bulkTransfers": {
|
98
|
+
parameters: {
|
99
|
+
query?: never;
|
100
|
+
header?: never;
|
101
|
+
path?: never;
|
102
|
+
cookie?: never;
|
103
|
+
};
|
104
|
+
get?: never;
|
105
|
+
put?: never;
|
33
106
|
/** Execute bulk transfer of funds from an external account to internal accounts. */
|
34
107
|
post: operations["BackendBulkTransfersPost"];
|
108
|
+
delete?: never;
|
109
|
+
options?: never;
|
110
|
+
head?: never;
|
111
|
+
patch?: never;
|
112
|
+
trace?: never;
|
35
113
|
};
|
36
114
|
"/bulkTransfers/{idValue}": {
|
115
|
+
parameters: {
|
116
|
+
query?: never;
|
117
|
+
header?: never;
|
118
|
+
path?: never;
|
119
|
+
cookie?: never;
|
120
|
+
};
|
37
121
|
/** Requests information relating to a bulk transfer identified by the specified identifier value. */
|
38
122
|
get: operations["BackendBulkTransfersGet"];
|
123
|
+
put?: never;
|
124
|
+
post?: never;
|
125
|
+
delete?: never;
|
126
|
+
options?: never;
|
127
|
+
head?: never;
|
128
|
+
patch?: never;
|
129
|
+
trace?: never;
|
39
130
|
};
|
40
131
|
"/otp/{transactionRequestId}": {
|
132
|
+
parameters: {
|
133
|
+
query?: never;
|
134
|
+
header?: never;
|
135
|
+
path?: never;
|
136
|
+
cookie?: never;
|
137
|
+
};
|
41
138
|
/** Requests OTP. */
|
42
139
|
get: operations["BackendOtpGet"];
|
140
|
+
put?: never;
|
141
|
+
post?: never;
|
142
|
+
delete?: never;
|
143
|
+
options?: never;
|
144
|
+
head?: never;
|
145
|
+
patch?: never;
|
146
|
+
trace?: never;
|
43
147
|
};
|
44
148
|
"/participants/{idType}/{idValue}": {
|
149
|
+
parameters: {
|
150
|
+
query?: never;
|
151
|
+
header?: never;
|
152
|
+
path?: never;
|
153
|
+
cookie?: never;
|
154
|
+
};
|
45
155
|
/**
|
46
156
|
* Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
|
47
157
|
* @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located.
|
48
158
|
*/
|
49
159
|
get: operations["BackendParticipantsGetByTypeAndID"];
|
160
|
+
put?: never;
|
161
|
+
post?: never;
|
162
|
+
delete?: never;
|
163
|
+
options?: never;
|
164
|
+
head?: never;
|
165
|
+
patch?: never;
|
166
|
+
trace?: never;
|
50
167
|
};
|
51
168
|
"/participants/{idType}/{idValue}/{idSubValue}": {
|
169
|
+
parameters: {
|
170
|
+
query?: never;
|
171
|
+
header?: never;
|
172
|
+
path?: never;
|
173
|
+
cookie?: never;
|
174
|
+
};
|
52
175
|
/**
|
53
176
|
* Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
|
54
177
|
* @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located.
|
55
178
|
*/
|
56
179
|
get: operations["BackendParticipantsGetByTypeIDAndSubId"];
|
180
|
+
put?: never;
|
181
|
+
post?: never;
|
182
|
+
delete?: never;
|
183
|
+
options?: never;
|
184
|
+
head?: never;
|
185
|
+
patch?: never;
|
186
|
+
trace?: never;
|
57
187
|
};
|
58
188
|
"/parties/{idType}/{idValue}": {
|
189
|
+
parameters: {
|
190
|
+
query?: never;
|
191
|
+
header?: never;
|
192
|
+
path?: never;
|
193
|
+
cookie?: never;
|
194
|
+
};
|
59
195
|
/**
|
60
196
|
* Requests information relating to a transfer party identified by the specified identifier type and value.
|
61
197
|
* @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`.
|
62
198
|
*/
|
63
199
|
get: operations["BackendPartiesGetByTypeAndID"];
|
200
|
+
put?: never;
|
201
|
+
post?: never;
|
202
|
+
delete?: never;
|
203
|
+
options?: never;
|
204
|
+
head?: never;
|
205
|
+
patch?: never;
|
206
|
+
trace?: never;
|
64
207
|
};
|
65
208
|
"/parties/{idType}/{idValue}/{idSubValue}": {
|
209
|
+
parameters: {
|
210
|
+
query?: never;
|
211
|
+
header?: never;
|
212
|
+
path?: never;
|
213
|
+
cookie?: never;
|
214
|
+
};
|
66
215
|
/**
|
67
216
|
* Requests information relating to a transfer party identified by the specified identifier type, value and subId value.
|
68
217
|
* @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`.
|
69
218
|
*/
|
70
219
|
get: operations["BackendPartiesGetByTypeIdAndSubId"];
|
220
|
+
put?: never;
|
221
|
+
post?: never;
|
222
|
+
delete?: never;
|
223
|
+
options?: never;
|
224
|
+
head?: never;
|
225
|
+
patch?: never;
|
226
|
+
trace?: never;
|
71
227
|
};
|
72
228
|
"/quoterequests": {
|
229
|
+
parameters: {
|
230
|
+
query?: never;
|
231
|
+
header?: never;
|
232
|
+
path?: never;
|
233
|
+
cookie?: never;
|
234
|
+
};
|
235
|
+
get?: never;
|
236
|
+
put?: never;
|
73
237
|
/**
|
74
238
|
* Requests a quote for the specified transfer.
|
75
239
|
* @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction.
|
76
240
|
*/
|
77
241
|
post: operations["BackendQuoteRequest"];
|
242
|
+
delete?: never;
|
243
|
+
options?: never;
|
244
|
+
head?: never;
|
245
|
+
patch?: never;
|
246
|
+
trace?: never;
|
78
247
|
};
|
79
248
|
"/transactionrequests": {
|
249
|
+
parameters: {
|
250
|
+
query?: never;
|
251
|
+
header?: never;
|
252
|
+
path?: never;
|
253
|
+
cookie?: never;
|
254
|
+
};
|
255
|
+
get?: never;
|
256
|
+
put?: never;
|
80
257
|
/** Transaction request that supports pull based transfers. */
|
81
258
|
post: operations["BackendTransactionRequest"];
|
259
|
+
delete?: never;
|
260
|
+
options?: never;
|
261
|
+
head?: never;
|
262
|
+
patch?: never;
|
263
|
+
trace?: never;
|
82
264
|
};
|
83
265
|
"/transfers": {
|
266
|
+
parameters: {
|
267
|
+
query?: never;
|
268
|
+
header?: never;
|
269
|
+
path?: never;
|
270
|
+
cookie?: never;
|
271
|
+
};
|
272
|
+
get?: never;
|
273
|
+
put?: never;
|
84
274
|
/**
|
85
275
|
* Transfers funds from an external account to an internal account.
|
86
276
|
* @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party.
|
87
277
|
*/
|
88
278
|
post: operations["BackendTransfersPost"];
|
279
|
+
delete?: never;
|
280
|
+
options?: never;
|
281
|
+
head?: never;
|
282
|
+
patch?: never;
|
283
|
+
trace?: never;
|
89
284
|
};
|
90
285
|
"/transfers/{transferId}": {
|
286
|
+
parameters: {
|
287
|
+
query?: never;
|
288
|
+
header?: never;
|
289
|
+
path?: never;
|
290
|
+
cookie?: never;
|
291
|
+
};
|
91
292
|
/**
|
92
293
|
* Retrieves information for a specific transfer.
|
93
294
|
* @description The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
@@ -98,6 +299,12 @@ export interface paths {
|
|
98
299
|
* @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee.
|
99
300
|
*/
|
100
301
|
put: operations["BackendTransfersPut"];
|
302
|
+
post?: never;
|
303
|
+
delete?: never;
|
304
|
+
options?: never;
|
305
|
+
head?: never;
|
306
|
+
patch?: never;
|
307
|
+
trace?: never;
|
101
308
|
};
|
102
309
|
}
|
103
310
|
export type webhooks = Record<string, never>;
|
@@ -238,6 +445,7 @@ export interface components {
|
|
238
445
|
/**
|
239
446
|
* ErrorCode
|
240
447
|
* @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) represents the specific error.
|
448
|
+
*
|
241
449
|
*/
|
242
450
|
errorCode: string;
|
243
451
|
/**
|
@@ -257,10 +465,9 @@ export interface components {
|
|
257
465
|
errorResponse: {
|
258
466
|
/** @description Error message text */
|
259
467
|
message?: string;
|
260
|
-
/**
|
261
|
-
*
|
262
|
-
*
|
263
|
-
*/
|
468
|
+
/** @description Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.
|
469
|
+
* Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
|
470
|
+
* */
|
264
471
|
statusCode?: string;
|
265
472
|
};
|
266
473
|
extensionItem: {
|
@@ -583,14 +790,14 @@ export interface components {
|
|
583
790
|
/**
|
584
791
|
* PartyIdType
|
585
792
|
* @description Below are the allowed values for the enumeration.
|
586
|
-
*
|
587
|
-
*
|
588
|
-
*
|
589
|
-
*
|
590
|
-
*
|
591
|
-
*
|
592
|
-
*
|
593
|
-
*
|
793
|
+
* - MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.
|
794
|
+
* - EMAIL - An email is used as reference to a participant. The format of the email should be according to the informational [RFC 3696](https://tools.ietf.org/html/rfc3696).
|
795
|
+
* - PERSONAL_ID - A personal identifier is used as reference to a participant. Examples of personal identification are passport number, birth certificate number, and national registration number. The identifier number is added in the PartyIdentifier element. The personal identifier type is added in the PartySubIdOrType element.
|
796
|
+
* - BUSINESS - A specific Business (for example, an organization or a company) is used as reference to a participant. The BUSINESS identifier can be in any format. To make a transaction connected to a specific username or bill number in a Business, the PartySubIdOrType element should be used.
|
797
|
+
* - DEVICE - A specific device (for example, a POS or ATM) ID connected to a specific business or organization is used as reference to a Party. For referencing a specific device under a specific business or organization, use the PartySubIdOrType element.
|
798
|
+
* - ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.
|
799
|
+
* - IBAN - A bank account number or FSP account ID is used as reference to a participant. The IBAN identifier can consist of up to 34 alphanumeric characters and should be entered without whitespace.
|
800
|
+
* - ALIAS An alias is used as reference to a participant. The alias should be created in the FSP as an alternative reference to an account owner. Another example of an alias is a username in the FSP system. The ALIAS identifier can be in any format. It is also possible to use the PartySubIdOrType element for identifying an account under an Alias defined by the PartyIdentifier.
|
594
801
|
* @enum {string}
|
595
802
|
*/
|
596
803
|
PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
|
@@ -677,8 +884,8 @@ export interface components {
|
|
677
884
|
/**
|
678
885
|
* AmountType
|
679
886
|
* @description Below are the allowed values for the enumeration AmountType.
|
680
|
-
*
|
681
|
-
*
|
887
|
+
* - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
888
|
+
* - RECEIVE - Amount the Payer would like the Payee to receive, that is, the amount that should be sent to the receiver exclusive of any fees.
|
682
889
|
* @example RECEIVE
|
683
890
|
* @enum {string}
|
684
891
|
*/
|
@@ -778,10 +985,10 @@ export interface components {
|
|
778
985
|
/**
|
779
986
|
* TransferState
|
780
987
|
* @description Below are the allowed values for the enumeration.
|
781
|
-
*
|
782
|
-
*
|
783
|
-
*
|
784
|
-
*
|
988
|
+
* - RECEIVED - Next ledger has received the transfer.
|
989
|
+
* - RESERVED - Next ledger has reserved the transfer.
|
990
|
+
* - COMMITTED - Next ledger has successfully performed the transfer.
|
991
|
+
* - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
|
785
992
|
* @example RESERVED
|
786
993
|
* @enum {string}
|
787
994
|
*/
|
@@ -832,9 +1039,9 @@ export interface components {
|
|
832
1039
|
/**
|
833
1040
|
* AuthenticationType
|
834
1041
|
* @description Below are the allowed values for the enumeration AuthenticationType.
|
835
|
-
*
|
836
|
-
*
|
837
|
-
*
|
1042
|
+
* - OTP - One-time password generated by the Payer FSP.
|
1043
|
+
* - QRCODE - QR code used as One Time Password.
|
1044
|
+
* - U2F - U2F is a new addition isolated to Thirdparty stream.
|
838
1045
|
* @example OTP
|
839
1046
|
* @enum {string}
|
840
1047
|
*/
|
@@ -843,16 +1050,25 @@ export interface components {
|
|
843
1050
|
responses: {
|
844
1051
|
/** @description Malformed or missing required headers or parameters. */
|
845
1052
|
400: {
|
1053
|
+
headers: {
|
1054
|
+
[name: string]: unknown;
|
1055
|
+
};
|
846
1056
|
content: {
|
847
1057
|
"application/json": components["schemas"]["errorResponse"];
|
848
1058
|
};
|
849
1059
|
};
|
850
1060
|
/** @description The party specified by the provided identifier type and value is not known to the server. */
|
851
1061
|
404: {
|
852
|
-
|
1062
|
+
headers: {
|
1063
|
+
[name: string]: unknown;
|
1064
|
+
};
|
1065
|
+
content?: never;
|
853
1066
|
};
|
854
1067
|
/** @description An error occurred processing the request. */
|
855
1068
|
500: {
|
1069
|
+
headers: {
|
1070
|
+
[name: string]: unknown;
|
1071
|
+
};
|
856
1072
|
content: {
|
857
1073
|
"application/json": components["schemas"]["errorResponse"];
|
858
1074
|
};
|
@@ -875,19 +1091,32 @@ export interface components {
|
|
875
1091
|
pathItems: never;
|
876
1092
|
}
|
877
1093
|
export type $defs = Record<string, never>;
|
878
|
-
export type external = Record<string, never>;
|
879
1094
|
export interface operations {
|
880
|
-
/** Health check endpoint. */
|
881
1095
|
BackendHealthCheck: {
|
1096
|
+
parameters: {
|
1097
|
+
query?: never;
|
1098
|
+
header?: never;
|
1099
|
+
path?: never;
|
1100
|
+
cookie?: never;
|
1101
|
+
};
|
1102
|
+
requestBody?: never;
|
882
1103
|
responses: {
|
883
1104
|
/** @description Returns empty body if the service is running. */
|
884
1105
|
200: {
|
885
|
-
|
1106
|
+
headers: {
|
1107
|
+
[name: string]: unknown;
|
1108
|
+
};
|
1109
|
+
content?: never;
|
886
1110
|
};
|
887
1111
|
};
|
888
1112
|
};
|
889
|
-
/** Requests a bulk quote. */
|
890
1113
|
BackendBulkQuotesPost: {
|
1114
|
+
parameters: {
|
1115
|
+
query?: never;
|
1116
|
+
header?: never;
|
1117
|
+
path?: never;
|
1118
|
+
cookie?: never;
|
1119
|
+
};
|
891
1120
|
/** @description Incoming request for a bulk quotation. */
|
892
1121
|
requestBody?: {
|
893
1122
|
content: {
|
@@ -897,6 +1126,9 @@ export interface operations {
|
|
897
1126
|
responses: {
|
898
1127
|
/** @description A response to the bulk quote request. */
|
899
1128
|
200: {
|
1129
|
+
headers: {
|
1130
|
+
[name: string]: unknown;
|
1131
|
+
};
|
900
1132
|
content: {
|
901
1133
|
"application/json": components["schemas"]["bulkQuoteResponse"];
|
902
1134
|
};
|
@@ -905,16 +1137,23 @@ export interface operations {
|
|
905
1137
|
500: components["responses"]["500"];
|
906
1138
|
};
|
907
1139
|
};
|
908
|
-
/** Requests information relating to a bulk quote identified by the specified identifier value. */
|
909
1140
|
BackendBulkQuotesGet: {
|
910
1141
|
parameters: {
|
1142
|
+
query?: never;
|
1143
|
+
header?: never;
|
911
1144
|
path: {
|
1145
|
+
/** @description The identifier value. */
|
912
1146
|
idValue: components["parameters"]["idValue"];
|
913
1147
|
};
|
1148
|
+
cookie?: never;
|
914
1149
|
};
|
1150
|
+
requestBody?: never;
|
915
1151
|
responses: {
|
916
1152
|
/** @description Response containing details of the requested bulk quote. */
|
917
1153
|
200: {
|
1154
|
+
headers: {
|
1155
|
+
[name: string]: unknown;
|
1156
|
+
};
|
918
1157
|
content: {
|
919
1158
|
"application/json": components["schemas"]["bulkQuoteResponse"];
|
920
1159
|
};
|
@@ -924,15 +1163,15 @@ export interface operations {
|
|
924
1163
|
500: components["responses"]["500"];
|
925
1164
|
};
|
926
1165
|
};
|
927
|
-
/**
|
928
|
-
* Callbacks for the bulk transaction request.
|
929
|
-
* @description The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
|
930
|
-
*/
|
931
1166
|
BackendBulkTransactionsPut: {
|
932
1167
|
parameters: {
|
1168
|
+
query?: never;
|
1169
|
+
header?: never;
|
933
1170
|
path: {
|
1171
|
+
/** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
|
934
1172
|
bulkTransactionId: components["parameters"]["bulkTransactionId"];
|
935
1173
|
};
|
1174
|
+
cookie?: never;
|
936
1175
|
};
|
937
1176
|
requestBody?: {
|
938
1177
|
content: {
|
@@ -942,21 +1181,23 @@ export interface operations {
|
|
942
1181
|
responses: {
|
943
1182
|
/** @description Bulk transaction information successfully amended. */
|
944
1183
|
202: {
|
945
|
-
|
1184
|
+
headers: {
|
1185
|
+
[name: string]: unknown;
|
1186
|
+
};
|
1187
|
+
content?: never;
|
946
1188
|
};
|
947
1189
|
400: components["responses"]["400"];
|
948
1190
|
500: components["responses"]["500"];
|
949
1191
|
};
|
950
1192
|
};
|
951
|
-
/**
|
952
|
-
* Callback for the requestToPay request.
|
953
|
-
* @description It is used to notify the DFSP backend about the status of the requestToPayTransfer.
|
954
|
-
*/
|
955
1193
|
RequestToPayPut: {
|
956
1194
|
parameters: {
|
1195
|
+
query?: never;
|
1196
|
+
header?: never;
|
957
1197
|
path: {
|
958
1198
|
transactionRequestId: components["parameters"]["transactionRequestId"];
|
959
1199
|
};
|
1200
|
+
cookie?: never;
|
960
1201
|
};
|
961
1202
|
requestBody?: {
|
962
1203
|
content: {
|
@@ -966,14 +1207,22 @@ export interface operations {
|
|
966
1207
|
responses: {
|
967
1208
|
/** @description OK */
|
968
1209
|
200: {
|
969
|
-
|
1210
|
+
headers: {
|
1211
|
+
[name: string]: unknown;
|
1212
|
+
};
|
1213
|
+
content?: never;
|
970
1214
|
};
|
971
1215
|
400: components["responses"]["400"];
|
972
1216
|
500: components["responses"]["500"];
|
973
1217
|
};
|
974
1218
|
};
|
975
|
-
/** Execute bulk transfer of funds from an external account to internal accounts. */
|
976
1219
|
BackendBulkTransfersPost: {
|
1220
|
+
parameters: {
|
1221
|
+
query?: never;
|
1222
|
+
header?: never;
|
1223
|
+
path?: never;
|
1224
|
+
cookie?: never;
|
1225
|
+
};
|
977
1226
|
/** @description An incoming bulk transfer request. */
|
978
1227
|
requestBody?: {
|
979
1228
|
content: {
|
@@ -983,6 +1232,9 @@ export interface operations {
|
|
983
1232
|
responses: {
|
984
1233
|
/** @description The bulk transfer was accepted. */
|
985
1234
|
200: {
|
1235
|
+
headers: {
|
1236
|
+
[name: string]: unknown;
|
1237
|
+
};
|
986
1238
|
content: {
|
987
1239
|
"application/json": components["schemas"]["bulkTransferResponse"];
|
988
1240
|
};
|
@@ -991,16 +1243,23 @@ export interface operations {
|
|
991
1243
|
500: components["responses"]["500"];
|
992
1244
|
};
|
993
1245
|
};
|
994
|
-
/** Requests information relating to a bulk transfer identified by the specified identifier value. */
|
995
1246
|
BackendBulkTransfersGet: {
|
996
1247
|
parameters: {
|
1248
|
+
query?: never;
|
1249
|
+
header?: never;
|
997
1250
|
path: {
|
1251
|
+
/** @description The identifier value. */
|
998
1252
|
idValue: components["parameters"]["idValue"];
|
999
1253
|
};
|
1254
|
+
cookie?: never;
|
1000
1255
|
};
|
1256
|
+
requestBody?: never;
|
1001
1257
|
responses: {
|
1002
1258
|
/** @description Response containing details of the requested bulk transfer. */
|
1003
1259
|
200: {
|
1260
|
+
headers: {
|
1261
|
+
[name: string]: unknown;
|
1262
|
+
};
|
1004
1263
|
content: {
|
1005
1264
|
"application/json": components["schemas"]["bulkTransferResponse"];
|
1006
1265
|
};
|
@@ -1010,16 +1269,22 @@ export interface operations {
|
|
1010
1269
|
500: components["responses"]["500"];
|
1011
1270
|
};
|
1012
1271
|
};
|
1013
|
-
/** Requests OTP. */
|
1014
1272
|
BackendOtpGet: {
|
1015
1273
|
parameters: {
|
1274
|
+
query?: never;
|
1275
|
+
header?: never;
|
1016
1276
|
path: {
|
1017
1277
|
transactionRequestId: components["parameters"]["transactionRequestId"];
|
1018
1278
|
};
|
1279
|
+
cookie?: never;
|
1019
1280
|
};
|
1281
|
+
requestBody?: never;
|
1020
1282
|
responses: {
|
1021
1283
|
/** @description Response containing details of the OTP. */
|
1022
1284
|
200: {
|
1285
|
+
headers: {
|
1286
|
+
[name: string]: unknown;
|
1287
|
+
};
|
1023
1288
|
content: {
|
1024
1289
|
"application/json": components["schemas"]["otpDetails"];
|
1025
1290
|
};
|
@@ -1029,20 +1294,25 @@ export interface operations {
|
|
1029
1294
|
500: components["responses"]["500"];
|
1030
1295
|
};
|
1031
1296
|
};
|
1032
|
-
/**
|
1033
|
-
* Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
|
1034
|
-
* @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located.
|
1035
|
-
*/
|
1036
1297
|
BackendParticipantsGetByTypeAndID: {
|
1037
1298
|
parameters: {
|
1299
|
+
query?: never;
|
1300
|
+
header?: never;
|
1038
1301
|
path: {
|
1302
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1039
1303
|
idType: components["parameters"]["idType"];
|
1304
|
+
/** @description The identifier value. */
|
1040
1305
|
idValue: components["parameters"]["idValue"];
|
1041
1306
|
};
|
1307
|
+
cookie?: never;
|
1042
1308
|
};
|
1309
|
+
requestBody?: never;
|
1043
1310
|
responses: {
|
1044
1311
|
/** @description Response containing details of the requested party. */
|
1045
1312
|
200: {
|
1313
|
+
headers: {
|
1314
|
+
[name: string]: unknown;
|
1315
|
+
};
|
1046
1316
|
content: {
|
1047
1317
|
"application/json": components["schemas"]["participantsResponse"];
|
1048
1318
|
};
|
@@ -1052,21 +1322,27 @@ export interface operations {
|
|
1052
1322
|
500: components["responses"]["500"];
|
1053
1323
|
};
|
1054
1324
|
};
|
1055
|
-
/**
|
1056
|
-
* Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
|
1057
|
-
* @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located.
|
1058
|
-
*/
|
1059
1325
|
BackendParticipantsGetByTypeIDAndSubId: {
|
1060
1326
|
parameters: {
|
1327
|
+
query?: never;
|
1328
|
+
header?: never;
|
1061
1329
|
path: {
|
1330
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1062
1331
|
idType: components["parameters"]["idType"];
|
1332
|
+
/** @description The identifier value. */
|
1063
1333
|
idValue: components["parameters"]["idValue"];
|
1334
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1064
1335
|
idSubValue: components["parameters"]["idSubValue"];
|
1065
1336
|
};
|
1337
|
+
cookie?: never;
|
1066
1338
|
};
|
1339
|
+
requestBody?: never;
|
1067
1340
|
responses: {
|
1068
1341
|
/** @description Response containing details of the requested party. */
|
1069
1342
|
200: {
|
1343
|
+
headers: {
|
1344
|
+
[name: string]: unknown;
|
1345
|
+
};
|
1070
1346
|
content: {
|
1071
1347
|
"application/json": components["schemas"]["participantsResponse"];
|
1072
1348
|
};
|
@@ -1076,20 +1352,25 @@ export interface operations {
|
|
1076
1352
|
500: components["responses"]["500"];
|
1077
1353
|
};
|
1078
1354
|
};
|
1079
|
-
/**
|
1080
|
-
* Requests information relating to a transfer party identified by the specified identifier type and value.
|
1081
|
-
* @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`.
|
1082
|
-
*/
|
1083
1355
|
BackendPartiesGetByTypeAndID: {
|
1084
1356
|
parameters: {
|
1357
|
+
query?: never;
|
1358
|
+
header?: never;
|
1085
1359
|
path: {
|
1360
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1086
1361
|
idType: components["parameters"]["idType"];
|
1362
|
+
/** @description The identifier value. */
|
1087
1363
|
idValue: components["parameters"]["idValue"];
|
1088
1364
|
};
|
1365
|
+
cookie?: never;
|
1089
1366
|
};
|
1367
|
+
requestBody?: never;
|
1090
1368
|
responses: {
|
1091
1369
|
/** @description Response containing details of the requested party. */
|
1092
1370
|
200: {
|
1371
|
+
headers: {
|
1372
|
+
[name: string]: unknown;
|
1373
|
+
};
|
1093
1374
|
content: {
|
1094
1375
|
"application/json": components["schemas"]["transferParty"];
|
1095
1376
|
};
|
@@ -1099,21 +1380,27 @@ export interface operations {
|
|
1099
1380
|
500: components["responses"]["500"];
|
1100
1381
|
};
|
1101
1382
|
};
|
1102
|
-
/**
|
1103
|
-
* Requests information relating to a transfer party identified by the specified identifier type, value and subId value.
|
1104
|
-
* @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`.
|
1105
|
-
*/
|
1106
1383
|
BackendPartiesGetByTypeIdAndSubId: {
|
1107
1384
|
parameters: {
|
1385
|
+
query?: never;
|
1386
|
+
header?: never;
|
1108
1387
|
path: {
|
1388
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1109
1389
|
idType: components["parameters"]["idType"];
|
1390
|
+
/** @description The identifier value. */
|
1110
1391
|
idValue: components["parameters"]["idValue"];
|
1392
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1111
1393
|
idSubValue: components["parameters"]["idSubValue"];
|
1112
1394
|
};
|
1395
|
+
cookie?: never;
|
1113
1396
|
};
|
1397
|
+
requestBody?: never;
|
1114
1398
|
responses: {
|
1115
1399
|
/** @description Response containing details of the requested party. */
|
1116
1400
|
200: {
|
1401
|
+
headers: {
|
1402
|
+
[name: string]: unknown;
|
1403
|
+
};
|
1117
1404
|
content: {
|
1118
1405
|
"application/json": components["schemas"]["transferParty"];
|
1119
1406
|
};
|
@@ -1123,11 +1410,13 @@ export interface operations {
|
|
1123
1410
|
500: components["responses"]["500"];
|
1124
1411
|
};
|
1125
1412
|
};
|
1126
|
-
/**
|
1127
|
-
* Requests a quote for the specified transfer.
|
1128
|
-
* @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction.
|
1129
|
-
*/
|
1130
1413
|
BackendQuoteRequest: {
|
1414
|
+
parameters: {
|
1415
|
+
query?: never;
|
1416
|
+
header?: never;
|
1417
|
+
path?: never;
|
1418
|
+
cookie?: never;
|
1419
|
+
};
|
1131
1420
|
/** @description Request for a transfer quotation. */
|
1132
1421
|
requestBody?: {
|
1133
1422
|
content: {
|
@@ -1137,6 +1426,9 @@ export interface operations {
|
|
1137
1426
|
responses: {
|
1138
1427
|
/** @description A response to the transfer quotation request. */
|
1139
1428
|
200: {
|
1429
|
+
headers: {
|
1430
|
+
[name: string]: unknown;
|
1431
|
+
};
|
1140
1432
|
content: {
|
1141
1433
|
"application/json": components["schemas"]["quoteResponse"];
|
1142
1434
|
};
|
@@ -1145,8 +1437,13 @@ export interface operations {
|
|
1145
1437
|
500: components["responses"]["500"];
|
1146
1438
|
};
|
1147
1439
|
};
|
1148
|
-
/** Transaction request that supports pull based transfers. */
|
1149
1440
|
BackendTransactionRequest: {
|
1441
|
+
parameters: {
|
1442
|
+
query?: never;
|
1443
|
+
header?: never;
|
1444
|
+
path?: never;
|
1445
|
+
cookie?: never;
|
1446
|
+
};
|
1150
1447
|
/** @description Request for Transaction Request. */
|
1151
1448
|
requestBody?: {
|
1152
1449
|
content: {
|
@@ -1156,6 +1453,9 @@ export interface operations {
|
|
1156
1453
|
responses: {
|
1157
1454
|
/** @description A response to the transfer transaction request. */
|
1158
1455
|
200: {
|
1456
|
+
headers: {
|
1457
|
+
[name: string]: unknown;
|
1458
|
+
};
|
1159
1459
|
content: {
|
1160
1460
|
"application/json": components["schemas"]["transactionRequestResponse"];
|
1161
1461
|
};
|
@@ -1164,11 +1464,13 @@ export interface operations {
|
|
1164
1464
|
500: components["responses"]["500"];
|
1165
1465
|
};
|
1166
1466
|
};
|
1167
|
-
/**
|
1168
|
-
* Transfers funds from an external account to an internal account.
|
1169
|
-
* @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party.
|
1170
|
-
*/
|
1171
1467
|
BackendTransfersPost: {
|
1468
|
+
parameters: {
|
1469
|
+
query?: never;
|
1470
|
+
header?: never;
|
1471
|
+
path?: never;
|
1472
|
+
cookie?: never;
|
1473
|
+
};
|
1172
1474
|
/** @description An incoming transfer request. */
|
1173
1475
|
requestBody?: {
|
1174
1476
|
content: {
|
@@ -1178,6 +1480,9 @@ export interface operations {
|
|
1178
1480
|
responses: {
|
1179
1481
|
/** @description The transfer was accepted. */
|
1180
1482
|
200: {
|
1483
|
+
headers: {
|
1484
|
+
[name: string]: unknown;
|
1485
|
+
};
|
1181
1486
|
content: {
|
1182
1487
|
"application/json": components["schemas"]["transferResponse"];
|
1183
1488
|
};
|
@@ -1186,19 +1491,22 @@ export interface operations {
|
|
1186
1491
|
500: components["responses"]["500"];
|
1187
1492
|
};
|
1188
1493
|
};
|
1189
|
-
/**
|
1190
|
-
* Retrieves information for a specific transfer.
|
1191
|
-
* @description The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
1192
|
-
*/
|
1193
1494
|
BackendTransfersGet: {
|
1194
1495
|
parameters: {
|
1496
|
+
query?: never;
|
1497
|
+
header?: never;
|
1195
1498
|
path: {
|
1196
1499
|
transferId: components["parameters"]["transferId"];
|
1197
1500
|
};
|
1501
|
+
cookie?: never;
|
1198
1502
|
};
|
1503
|
+
requestBody?: never;
|
1199
1504
|
responses: {
|
1200
1505
|
/** @description The transfer was accepted. */
|
1201
1506
|
200: {
|
1507
|
+
headers: {
|
1508
|
+
[name: string]: unknown;
|
1509
|
+
};
|
1202
1510
|
content: {
|
1203
1511
|
"application/json": components["schemas"]["transferDetailsResponse"];
|
1204
1512
|
};
|
@@ -1206,15 +1514,14 @@ export interface operations {
|
|
1206
1514
|
500: components["responses"]["500"];
|
1207
1515
|
};
|
1208
1516
|
};
|
1209
|
-
/**
|
1210
|
-
* Receive notification for a specific transfer.
|
1211
|
-
* @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee.
|
1212
|
-
*/
|
1213
1517
|
BackendTransfersPut: {
|
1214
1518
|
parameters: {
|
1519
|
+
query?: never;
|
1520
|
+
header?: never;
|
1215
1521
|
path: {
|
1216
1522
|
transferId: components["parameters"]["transferId"];
|
1217
1523
|
};
|
1524
|
+
cookie?: never;
|
1218
1525
|
};
|
1219
1526
|
/** @description An incoming notification for fulfiled transfer. */
|
1220
1527
|
requestBody?: {
|
@@ -1225,7 +1532,10 @@ export interface operations {
|
|
1225
1532
|
responses: {
|
1226
1533
|
/** @description The notification was accepted. */
|
1227
1534
|
200: {
|
1228
|
-
|
1535
|
+
headers: {
|
1536
|
+
[name: string]: unknown;
|
1537
|
+
};
|
1538
|
+
content?: never;
|
1229
1539
|
};
|
1230
1540
|
500: components["responses"]["500"];
|
1231
1541
|
};
|