@mojaloop/api-snippets 17.6.0-snapshot.2 → 17.6.1
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 +4 -2
- package/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +6053 -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 +1 -1
- 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/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 +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml +20 -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 +20 -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 +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml +24 -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 +41 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml +38 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml +44 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml +45 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml +53 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml +39 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml +92 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml +84 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml +203 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml +117 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml +38 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml +23 -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 +69 -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 +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +65 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +65 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml +85 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml +89 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml +65 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml +70 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml +77 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml +72 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml +54 -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 +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml +34 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LEIIdentifier.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml +22 -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 +31 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml +31 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml +22 -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 +30 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml +45 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml +70 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml +63 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml +62 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml +48 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml +24 -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 +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml +20 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml +37 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml +39 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml +56 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml +20 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml +105 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml +27 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml +36 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml +74 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml +29 -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 +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml +77 -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 +118444 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.d.ts +6077 -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 +106043 -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 +14 -14
- 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/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,326 +4,634 @@
|
|
4
4
|
*/
|
5
5
|
export interface paths {
|
6
6
|
"/interface": {
|
7
|
+
parameters: {
|
8
|
+
query?: never;
|
9
|
+
header?: never;
|
10
|
+
path?: never;
|
11
|
+
cookie?: never;
|
12
|
+
};
|
13
|
+
get?: never;
|
14
|
+
put?: never;
|
7
15
|
/** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
8
16
|
post: operations["test"];
|
17
|
+
delete?: never;
|
18
|
+
options?: never;
|
19
|
+
head?: never;
|
20
|
+
patch?: never;
|
21
|
+
trace?: never;
|
9
22
|
};
|
10
23
|
"/accounts/{ID}": {
|
11
|
-
/**
|
12
|
-
* GetAccountsByUserId
|
13
|
-
* @description The HTTP request `GET /accounts/{ID}` is used to retrieve the list of potential accounts available for linking.
|
14
|
-
*/
|
15
|
-
get: operations["GetAccountsByUserId"];
|
16
|
-
/**
|
17
|
-
* UpdateAccountsByUserId
|
18
|
-
* @description The HTTP request `PUT /accounts/{ID}` is used to return the list of potential accounts available for linking
|
19
|
-
*/
|
20
|
-
put: operations["UpdateAccountsByUserId"];
|
21
24
|
parameters: {
|
25
|
+
query?: never;
|
22
26
|
header: {
|
27
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
23
28
|
"Content-Type": components["parameters"]["Content-Type"];
|
29
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
24
30
|
Date: components["parameters"]["Date"];
|
31
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
32
|
+
*
|
33
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
25
34
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
35
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
26
36
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
37
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
27
38
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
39
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
28
40
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
41
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
29
42
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
43
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
30
44
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
45
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
31
46
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
32
47
|
};
|
33
48
|
path: {
|
49
|
+
/** @description The identifier value. */
|
34
50
|
ID: components["parameters"]["ID"];
|
35
51
|
};
|
52
|
+
cookie?: never;
|
36
53
|
};
|
37
|
-
};
|
38
|
-
"/accounts/{ID}/error": {
|
39
54
|
/**
|
40
|
-
*
|
41
|
-
* @description The HTTP request `
|
55
|
+
* GetAccountsByUserId
|
56
|
+
* @description The HTTP request `GET /accounts/{ID}` is used to retrieve the list of potential accounts available for linking.
|
57
|
+
*
|
42
58
|
*/
|
43
|
-
|
59
|
+
get: operations["GetAccountsByUserId"];
|
60
|
+
/**
|
61
|
+
* UpdateAccountsByUserId
|
62
|
+
* @description The HTTP request `PUT /accounts/{ID}` is used to return the list of potential accounts available for linking
|
63
|
+
*
|
64
|
+
*/
|
65
|
+
put: operations["UpdateAccountsByUserId"];
|
66
|
+
post?: never;
|
67
|
+
delete?: never;
|
68
|
+
options?: never;
|
69
|
+
head?: never;
|
70
|
+
patch?: never;
|
71
|
+
trace?: never;
|
72
|
+
};
|
73
|
+
"/accounts/{ID}/error": {
|
44
74
|
parameters: {
|
75
|
+
query?: never;
|
45
76
|
header: {
|
77
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
46
78
|
"Content-Type": components["parameters"]["Content-Type"];
|
79
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
47
80
|
Date: components["parameters"]["Date"];
|
81
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
82
|
+
*
|
83
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
48
84
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
85
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
49
86
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
87
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
50
88
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
89
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
51
90
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
91
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
52
92
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
93
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
53
94
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
95
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
54
96
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
55
97
|
};
|
56
98
|
path: {
|
99
|
+
/** @description The identifier value. */
|
57
100
|
ID: components["parameters"]["ID"];
|
58
101
|
};
|
102
|
+
cookie?: never;
|
59
103
|
};
|
104
|
+
get?: never;
|
105
|
+
/**
|
106
|
+
* UpdateAccountsByUserIdError
|
107
|
+
* @description The HTTP request `PUT /accounts/{ID}/error` is used to return error information
|
108
|
+
*
|
109
|
+
*/
|
110
|
+
put: operations["UpdateAccountsByUserIdError"];
|
111
|
+
post?: never;
|
112
|
+
delete?: never;
|
113
|
+
options?: never;
|
114
|
+
head?: never;
|
115
|
+
patch?: never;
|
116
|
+
trace?: never;
|
60
117
|
};
|
61
118
|
"/health": {
|
119
|
+
parameters: {
|
120
|
+
query?: never;
|
121
|
+
header?: never;
|
122
|
+
path?: never;
|
123
|
+
cookie?: never;
|
124
|
+
};
|
62
125
|
/**
|
63
126
|
* Health check endpoint
|
64
127
|
* @description The HTTP request GET /health is used to return the current status of the API.
|
65
128
|
*/
|
66
129
|
get: operations["HealthGet"];
|
130
|
+
put?: never;
|
131
|
+
post?: never;
|
132
|
+
delete?: never;
|
133
|
+
options?: never;
|
134
|
+
head?: never;
|
135
|
+
patch?: never;
|
136
|
+
trace?: never;
|
67
137
|
};
|
68
138
|
"/metrics": {
|
139
|
+
parameters: {
|
140
|
+
query?: never;
|
141
|
+
header?: never;
|
142
|
+
path?: never;
|
143
|
+
cookie?: never;
|
144
|
+
};
|
69
145
|
/**
|
70
146
|
* Prometheus metrics endpoint
|
71
147
|
* @description The HTTP request GET /metrics is used to return metrics for the API.
|
72
148
|
*/
|
73
149
|
get: operations["MetricsGet"];
|
150
|
+
put?: never;
|
151
|
+
post?: never;
|
152
|
+
delete?: never;
|
153
|
+
options?: never;
|
154
|
+
head?: never;
|
155
|
+
patch?: never;
|
156
|
+
trace?: never;
|
74
157
|
};
|
75
158
|
"/consentRequests": {
|
159
|
+
parameters: {
|
160
|
+
query?: never;
|
161
|
+
header: {
|
162
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
163
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
164
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
165
|
+
Date: components["parameters"]["Date"];
|
166
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
167
|
+
*
|
168
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
169
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
170
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
171
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
172
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
173
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
174
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
175
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
176
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
177
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
178
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
179
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
180
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
181
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
182
|
+
};
|
183
|
+
path?: never;
|
184
|
+
cookie?: never;
|
185
|
+
};
|
186
|
+
get?: never;
|
187
|
+
put?: never;
|
76
188
|
/**
|
77
189
|
* CreateConsentRequest
|
78
190
|
* @description The HTTP request **POST /consentRequests** is used to request a DFSP to grant access to one or more
|
79
|
-
*
|
191
|
+
* accounts owned by a customer of the DFSP for the PISP who sends the request.
|
192
|
+
*
|
80
193
|
*/
|
81
194
|
post: operations["CreateConsentRequest"];
|
195
|
+
delete?: never;
|
196
|
+
options?: never;
|
197
|
+
head?: never;
|
198
|
+
patch?: never;
|
199
|
+
trace?: never;
|
200
|
+
};
|
201
|
+
"/consentRequests/{ID}": {
|
82
202
|
parameters: {
|
203
|
+
query?: never;
|
83
204
|
header: {
|
205
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
84
206
|
"Content-Type": components["parameters"]["Content-Type"];
|
207
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
85
208
|
Date: components["parameters"]["Date"];
|
209
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
210
|
+
*
|
211
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
86
212
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
213
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
87
214
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
215
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
88
216
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
217
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
89
218
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
219
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
90
220
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
221
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
91
222
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
223
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
92
224
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
93
225
|
};
|
226
|
+
path: {
|
227
|
+
/** @description The identifier value. */
|
228
|
+
ID: components["parameters"]["ID"];
|
229
|
+
};
|
230
|
+
cookie?: never;
|
94
231
|
};
|
95
|
-
};
|
96
|
-
"/consentRequests/{ID}": {
|
97
232
|
/**
|
98
233
|
* GetConsentRequestsById
|
99
234
|
* @description The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously
|
100
|
-
*
|
101
|
-
*
|
235
|
+
* requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the
|
236
|
+
* request by the PISP when the PISP originated the request.
|
237
|
+
*
|
102
238
|
*/
|
103
239
|
get: operations["GetConsentRequestsById"];
|
104
240
|
/**
|
105
241
|
* UpdateConsentRequest
|
106
242
|
* @description A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted,
|
107
|
-
*
|
108
|
-
*
|
243
|
+
* and (2) communicate to the PISP which `authChannel` it should use to authenticate their user
|
244
|
+
* with.
|
245
|
+
*
|
246
|
+
* When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all
|
247
|
+
* the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization
|
248
|
+
* process may result in additional privileges being granted by the account holder to the PISP. The
|
249
|
+
* **PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a
|
250
|
+
* particular authorization request.
|
109
251
|
*
|
110
|
-
* When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all
|
111
|
-
* the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization
|
112
|
-
* process may result in additional privileges being granted by the account holder to the PISP. The
|
113
|
-
* **PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a
|
114
|
-
* particular authorization request.
|
115
252
|
*/
|
116
253
|
put: operations["UpdateConsentRequest"];
|
254
|
+
post?: never;
|
255
|
+
delete?: never;
|
256
|
+
options?: never;
|
257
|
+
head?: never;
|
117
258
|
/**
|
118
259
|
* PatchConsentRequest
|
119
260
|
* @description After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
|
261
|
+
*
|
120
262
|
*/
|
121
263
|
patch: operations["PatchConsentRequest"];
|
264
|
+
trace?: never;
|
265
|
+
};
|
266
|
+
"/consentRequests/{ID}/error": {
|
122
267
|
parameters: {
|
268
|
+
query?: never;
|
123
269
|
header: {
|
270
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
124
271
|
"Content-Type": components["parameters"]["Content-Type"];
|
272
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
125
273
|
Date: components["parameters"]["Date"];
|
274
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
275
|
+
*
|
276
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
126
277
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
278
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
127
279
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
280
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
128
281
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
282
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
129
283
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
284
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
130
285
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
286
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
131
287
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
288
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
132
289
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
133
290
|
};
|
134
291
|
path: {
|
292
|
+
/** @description The identifier value. */
|
135
293
|
ID: components["parameters"]["ID"];
|
136
294
|
};
|
295
|
+
cookie?: never;
|
137
296
|
};
|
138
|
-
|
139
|
-
"/consentRequests/{ID}/error": {
|
297
|
+
get?: never;
|
140
298
|
/**
|
141
299
|
* NotifyErrorConsentRequests
|
142
300
|
* @description DFSP responds to the PISP if something went wrong with validating an OTP or secret.
|
301
|
+
*
|
143
302
|
*/
|
144
303
|
put: operations["NotifyErrorConsentRequests"];
|
304
|
+
post?: never;
|
305
|
+
delete?: never;
|
306
|
+
options?: never;
|
307
|
+
head?: never;
|
308
|
+
patch?: never;
|
309
|
+
trace?: never;
|
310
|
+
};
|
311
|
+
"/consents": {
|
145
312
|
parameters: {
|
313
|
+
query?: never;
|
146
314
|
header: {
|
315
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
147
316
|
"Content-Type": components["parameters"]["Content-Type"];
|
317
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
148
318
|
Date: components["parameters"]["Date"];
|
319
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
320
|
+
*
|
321
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
149
322
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
323
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
150
324
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
325
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
151
326
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
327
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
152
328
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
329
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
153
330
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
331
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
154
332
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
333
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
155
334
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
156
335
|
};
|
157
|
-
path
|
158
|
-
|
159
|
-
};
|
336
|
+
path?: never;
|
337
|
+
cookie?: never;
|
160
338
|
};
|
161
|
-
|
162
|
-
|
339
|
+
get?: never;
|
340
|
+
put?: never;
|
163
341
|
/**
|
164
342
|
* PostConsents
|
165
343
|
* @description The **POST /consents** request is used to request the creation of a consent for interactions between a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to.
|
344
|
+
*
|
166
345
|
*/
|
167
346
|
post: operations["PostConsents"];
|
347
|
+
delete?: never;
|
348
|
+
options?: never;
|
349
|
+
head?: never;
|
350
|
+
patch?: never;
|
351
|
+
trace?: never;
|
352
|
+
};
|
353
|
+
"/consents/{ID}": {
|
168
354
|
parameters: {
|
355
|
+
query?: never;
|
169
356
|
header: {
|
357
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
170
358
|
"Content-Type": components["parameters"]["Content-Type"];
|
359
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
171
360
|
Date: components["parameters"]["Date"];
|
361
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
362
|
+
*
|
363
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
172
364
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
365
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
173
366
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
367
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
174
368
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
369
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
175
370
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
371
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
176
372
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
373
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
177
374
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
375
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
178
376
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
179
377
|
};
|
378
|
+
path: {
|
379
|
+
/** @description The identifier value. */
|
380
|
+
ID: components["parameters"]["ID"];
|
381
|
+
};
|
382
|
+
cookie?: never;
|
180
383
|
};
|
181
|
-
};
|
182
|
-
"/consents/{ID}": {
|
183
384
|
/**
|
184
385
|
* GetConsent
|
185
386
|
* @description The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created.
|
387
|
+
*
|
186
388
|
*/
|
187
389
|
get: operations["GetConsent"];
|
188
390
|
/**
|
189
391
|
* PutConsentByID
|
190
392
|
* @description The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth Service.
|
191
393
|
*
|
192
|
-
*
|
193
|
-
*
|
394
|
+
* - Called by a `PISP` to after signing a challenge. Sent to an DFSP for verification.
|
395
|
+
* - Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
|
396
|
+
*
|
194
397
|
*/
|
195
398
|
put: operations["PutConsentByID"];
|
196
|
-
|
197
|
-
|
399
|
+
post?: never;
|
400
|
+
/** @description Used by PISP, DFSP
|
198
401
|
*
|
199
|
-
*
|
200
|
-
*
|
201
|
-
*
|
202
|
-
*
|
203
|
-
*/
|
402
|
+
* The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent.
|
403
|
+
* For tracing and auditing purposes, the switch should be sure not to delete the consent physically;
|
404
|
+
* instead, information relating to the consent should be marked as deleted and requests relating to the
|
405
|
+
* consent should not be honoured.
|
406
|
+
* */
|
204
407
|
delete: operations["DeleteConsentByID"];
|
408
|
+
options?: never;
|
409
|
+
head?: never;
|
205
410
|
/**
|
206
411
|
* PatchConsentByID
|
207
412
|
* @description The HTTP request `PATCH /consents/{ID}` is used
|
208
413
|
*
|
209
|
-
*
|
210
|
-
*
|
211
|
-
*
|
414
|
+
* - In account linking in the Credential Registration phase. Used by a DFSP
|
415
|
+
* to notify a PISP a credential has been verified and registered with an
|
416
|
+
* Auth service.
|
212
417
|
*
|
213
|
-
*
|
214
|
-
*
|
418
|
+
* - In account unlinking by a hub hosted auth service and by DFSPs
|
419
|
+
* in non-hub hosted scenarios to notify participants of a consent being revoked.
|
420
|
+
*
|
421
|
+
* Called by a `auth-service` to notify a PISP and DFSP of consent status in hub hosted scenario.
|
422
|
+
* Called by a `DFSP` to notify a PISP of consent status in non-hub hosted scenario.
|
215
423
|
*
|
216
|
-
* Called by a `auth-service` to notify a PISP and DFSP of consent status in hub hosted scenario.
|
217
|
-
* Called by a `DFSP` to notify a PISP of consent status in non-hub hosted scenario.
|
218
424
|
*/
|
219
425
|
patch: operations["PatchConsentByID"];
|
426
|
+
trace?: never;
|
427
|
+
};
|
428
|
+
"/consents/{ID}/error": {
|
220
429
|
parameters: {
|
430
|
+
query?: never;
|
221
431
|
header: {
|
432
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
222
433
|
"Content-Type": components["parameters"]["Content-Type"];
|
434
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
223
435
|
Date: components["parameters"]["Date"];
|
436
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
437
|
+
*
|
438
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
224
439
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
440
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
225
441
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
442
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
226
443
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
444
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
227
445
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
446
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
228
447
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
448
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
229
449
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
450
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
230
451
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
231
452
|
};
|
232
453
|
path: {
|
454
|
+
/** @description The identifier value. */
|
233
455
|
ID: components["parameters"]["ID"];
|
234
456
|
};
|
457
|
+
cookie?: never;
|
235
458
|
};
|
236
|
-
|
237
|
-
"/consents/{ID}/error": {
|
459
|
+
get?: never;
|
238
460
|
/**
|
239
461
|
* NotifyErrorConsents
|
240
462
|
* @description DFSP responds to the PISP if something went wrong with validating or storing consent.
|
463
|
+
*
|
241
464
|
*/
|
242
465
|
put: operations["NotifyErrorConsents"];
|
466
|
+
post?: never;
|
467
|
+
delete?: never;
|
468
|
+
options?: never;
|
469
|
+
head?: never;
|
470
|
+
patch?: never;
|
471
|
+
trace?: never;
|
472
|
+
};
|
473
|
+
"/participants": {
|
243
474
|
parameters: {
|
475
|
+
query?: never;
|
244
476
|
header: {
|
477
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
245
478
|
"Content-Type": components["parameters"]["Content-Type"];
|
479
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
246
480
|
Date: components["parameters"]["Date"];
|
481
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
482
|
+
*
|
483
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
247
484
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
485
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
248
486
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
487
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
249
488
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
489
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
250
490
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
491
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
251
492
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
493
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
252
494
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
495
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
253
496
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
254
497
|
};
|
255
|
-
path
|
256
|
-
|
257
|
-
};
|
498
|
+
path?: never;
|
499
|
+
cookie?: never;
|
258
500
|
};
|
259
|
-
|
260
|
-
|
501
|
+
get?: never;
|
502
|
+
put?: never;
|
261
503
|
/**
|
262
504
|
* Create bulk participant information
|
263
505
|
* @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.
|
264
506
|
*/
|
265
507
|
post: operations["Participants1"];
|
508
|
+
delete?: never;
|
509
|
+
options?: never;
|
510
|
+
head?: never;
|
511
|
+
patch?: never;
|
512
|
+
trace?: never;
|
513
|
+
};
|
514
|
+
"/participants/{ID}": {
|
266
515
|
parameters: {
|
516
|
+
query?: never;
|
267
517
|
header: {
|
518
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
268
519
|
"Content-Type": components["parameters"]["Content-Type"];
|
520
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
269
521
|
Date: components["parameters"]["Date"];
|
522
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
523
|
+
*
|
524
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
270
525
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
526
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
271
527
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
528
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
272
529
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
530
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
273
531
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
532
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
274
533
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
534
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
275
535
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
536
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
276
537
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
277
538
|
};
|
539
|
+
path: {
|
540
|
+
/** @description The identifier value. */
|
541
|
+
ID: components["parameters"]["ID"];
|
542
|
+
};
|
543
|
+
cookie?: never;
|
278
544
|
};
|
279
|
-
|
280
|
-
"/participants/{ID}": {
|
545
|
+
get?: never;
|
281
546
|
/**
|
282
547
|
* Return bulk participant information
|
283
548
|
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
284
549
|
*/
|
285
550
|
put: operations["PutParticipantsByID"];
|
551
|
+
post?: never;
|
552
|
+
delete?: never;
|
553
|
+
options?: never;
|
554
|
+
head?: never;
|
555
|
+
patch?: never;
|
556
|
+
trace?: never;
|
557
|
+
};
|
558
|
+
"/participants/{ID}/error": {
|
286
559
|
parameters: {
|
560
|
+
query?: never;
|
287
561
|
header: {
|
562
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
288
563
|
"Content-Type": components["parameters"]["Content-Type"];
|
564
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
289
565
|
Date: components["parameters"]["Date"];
|
566
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
567
|
+
*
|
568
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
290
569
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
570
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
291
571
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
572
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
292
573
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
574
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
293
575
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
576
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
294
577
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
578
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
295
579
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
580
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
296
581
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
297
582
|
};
|
298
583
|
path: {
|
584
|
+
/** @description The identifier value. */
|
299
585
|
ID: components["parameters"]["ID"];
|
300
586
|
};
|
587
|
+
cookie?: never;
|
301
588
|
};
|
302
|
-
|
303
|
-
"/participants/{ID}/error": {
|
589
|
+
get?: never;
|
304
590
|
/**
|
305
591
|
* Return bulk participant information error
|
306
592
|
* @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information.
|
307
593
|
*/
|
308
594
|
put: operations["PutParticipantsByIDAndError"];
|
595
|
+
post?: never;
|
596
|
+
delete?: never;
|
597
|
+
options?: never;
|
598
|
+
head?: never;
|
599
|
+
patch?: never;
|
600
|
+
trace?: never;
|
601
|
+
};
|
602
|
+
"/participants/{Type}/{ID}": {
|
309
603
|
parameters: {
|
604
|
+
query?: never;
|
310
605
|
header: {
|
606
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
311
607
|
"Content-Type": components["parameters"]["Content-Type"];
|
608
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
312
609
|
Date: components["parameters"]["Date"];
|
610
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
611
|
+
*
|
612
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
313
613
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
614
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
314
615
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
616
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
315
617
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
618
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
316
619
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
620
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
317
621
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
622
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
318
623
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
624
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
319
625
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
320
626
|
};
|
321
627
|
path: {
|
628
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
629
|
+
Type: components["parameters"]["Type"];
|
630
|
+
/** @description The identifier value. */
|
322
631
|
ID: components["parameters"]["ID"];
|
323
632
|
};
|
633
|
+
cookie?: never;
|
324
634
|
};
|
325
|
-
};
|
326
|
-
"/participants/{Type}/{ID}": {
|
327
635
|
/**
|
328
636
|
* Look up participant information
|
329
637
|
* @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
@@ -343,349 +651,598 @@ export interface paths {
|
|
343
651
|
* Delete participant information
|
344
652
|
* @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
345
653
|
*
|
346
|
-
*
|
654
|
+
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
347
655
|
*/
|
348
656
|
delete: operations["ParticipantsByTypeAndID2"];
|
657
|
+
options?: never;
|
658
|
+
head?: never;
|
659
|
+
patch?: never;
|
660
|
+
trace?: never;
|
661
|
+
};
|
662
|
+
"/participants/{Type}/{ID}/error": {
|
349
663
|
parameters: {
|
664
|
+
query?: never;
|
350
665
|
header: {
|
666
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
351
667
|
"Content-Type": components["parameters"]["Content-Type"];
|
668
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
352
669
|
Date: components["parameters"]["Date"];
|
670
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
671
|
+
*
|
672
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
353
673
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
674
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
354
675
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
676
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
355
677
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
678
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
356
679
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
680
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
357
681
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
682
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
358
683
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
684
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
359
685
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
360
686
|
};
|
361
687
|
path: {
|
688
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
362
689
|
Type: components["parameters"]["Type"];
|
690
|
+
/** @description The identifier value. */
|
363
691
|
ID: components["parameters"]["ID"];
|
364
692
|
};
|
693
|
+
cookie?: never;
|
365
694
|
};
|
366
|
-
|
367
|
-
"/participants/{Type}/{ID}/error": {
|
695
|
+
get?: never;
|
368
696
|
/**
|
369
697
|
* Return participant information error
|
370
698
|
* @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
|
371
699
|
*/
|
372
700
|
put: operations["ParticipantsErrorByTypeAndID"];
|
701
|
+
post?: never;
|
702
|
+
delete?: never;
|
703
|
+
options?: never;
|
704
|
+
head?: never;
|
705
|
+
patch?: never;
|
706
|
+
trace?: never;
|
707
|
+
};
|
708
|
+
"/services/{ServiceType}": {
|
373
709
|
parameters: {
|
710
|
+
query?: never;
|
374
711
|
header: {
|
712
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
375
713
|
"Content-Type": components["parameters"]["Content-Type"];
|
714
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
376
715
|
Date: components["parameters"]["Date"];
|
716
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
717
|
+
*
|
718
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
377
719
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
720
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
378
721
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
722
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
379
723
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
724
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
380
725
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
726
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
381
727
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
728
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
382
729
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
730
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
383
731
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
384
732
|
};
|
385
733
|
path: {
|
386
|
-
|
387
|
-
|
734
|
+
/** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
735
|
+
ServiceType: components["parameters"]["ServiceType"];
|
388
736
|
};
|
737
|
+
cookie?: never;
|
389
738
|
};
|
390
|
-
};
|
391
|
-
"/services/{ServiceType}": {
|
392
739
|
/**
|
393
740
|
* GetServicesByServiceType
|
394
741
|
* @description The HTTP request `GET /services/{ServiceType}` is used to retrieve the list of participants
|
395
|
-
*
|
742
|
+
* that support a specified service.
|
743
|
+
*
|
396
744
|
*/
|
397
745
|
get: operations["GetServicesByServiceType"];
|
398
746
|
/**
|
399
747
|
* PutServicesByServiceType
|
400
748
|
* @description The HTTP request `PUT /services/{ServiceType}` is used to return list of participants
|
401
|
-
*
|
749
|
+
* that support a specified service.
|
750
|
+
*
|
402
751
|
*/
|
403
752
|
put: operations["PutServicesByServiceType"];
|
753
|
+
post?: never;
|
754
|
+
delete?: never;
|
755
|
+
options?: never;
|
756
|
+
head?: never;
|
757
|
+
patch?: never;
|
758
|
+
trace?: never;
|
759
|
+
};
|
760
|
+
"/services/{ServiceType}/error": {
|
404
761
|
parameters: {
|
762
|
+
query?: never;
|
405
763
|
header: {
|
764
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
406
765
|
"Content-Type": components["parameters"]["Content-Type"];
|
766
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
407
767
|
Date: components["parameters"]["Date"];
|
768
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
769
|
+
*
|
770
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
408
771
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
772
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
409
773
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
774
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
410
775
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
776
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
411
777
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
778
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
412
779
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
780
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
413
781
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
782
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
414
783
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
415
784
|
};
|
416
785
|
path: {
|
786
|
+
/** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
417
787
|
ServiceType: components["parameters"]["ServiceType"];
|
418
788
|
};
|
789
|
+
cookie?: never;
|
419
790
|
};
|
420
|
-
|
421
|
-
"/services/{ServiceType}/error": {
|
791
|
+
get?: never;
|
422
792
|
/**
|
423
793
|
* PutServicesByServiceTypeAndError
|
424
794
|
* @description The HTTP request `PUT /services/{ServiceType}/error` is used to return error information
|
795
|
+
*
|
425
796
|
*/
|
426
797
|
put: operations["PutServicesByServiceTypeAndError"];
|
798
|
+
post?: never;
|
799
|
+
delete?: never;
|
800
|
+
options?: never;
|
801
|
+
head?: never;
|
802
|
+
patch?: never;
|
803
|
+
trace?: never;
|
804
|
+
};
|
805
|
+
"/thirdpartyRequests/transactions": {
|
427
806
|
parameters: {
|
807
|
+
query?: never;
|
428
808
|
header: {
|
809
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
429
810
|
"Content-Type": components["parameters"]["Content-Type"];
|
811
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
430
812
|
Date: components["parameters"]["Date"];
|
813
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
814
|
+
*
|
815
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
431
816
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
817
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
432
818
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
819
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
433
820
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
821
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
434
822
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
823
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
435
824
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
825
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
436
826
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
827
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
437
828
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
438
829
|
};
|
439
|
-
path
|
440
|
-
|
441
|
-
};
|
830
|
+
path?: never;
|
831
|
+
cookie?: never;
|
442
832
|
};
|
443
|
-
|
444
|
-
|
833
|
+
get?: never;
|
834
|
+
put?: never;
|
445
835
|
/**
|
446
836
|
* ThirdpartyRequestsTransactionsPost
|
447
837
|
* @description The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
|
448
838
|
*/
|
449
839
|
post: operations["ThirdpartyRequestsTransactionsPost"];
|
840
|
+
delete?: never;
|
841
|
+
options?: never;
|
842
|
+
head?: never;
|
843
|
+
patch?: never;
|
844
|
+
trace?: never;
|
845
|
+
};
|
846
|
+
"/thirdpartyRequests/transactions/{ID}": {
|
450
847
|
parameters: {
|
848
|
+
query?: never;
|
451
849
|
header: {
|
850
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
452
851
|
"Content-Type": components["parameters"]["Content-Type"];
|
852
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
453
853
|
Date: components["parameters"]["Date"];
|
854
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
855
|
+
*
|
856
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
454
857
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
858
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
455
859
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
860
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
456
861
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
862
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
457
863
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
864
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
458
865
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
866
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
459
867
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
868
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
460
869
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
461
870
|
};
|
871
|
+
path: {
|
872
|
+
/** @description The identifier value. */
|
873
|
+
ID: components["parameters"]["ID"];
|
874
|
+
};
|
875
|
+
cookie?: never;
|
462
876
|
};
|
463
|
-
};
|
464
|
-
"/thirdpartyRequests/transactions/{ID}": {
|
465
877
|
/**
|
466
878
|
* GetThirdpartyTransactionRequests
|
467
879
|
* @description The HTTP request `GET /thirdpartyRequests/transactions/{ID}` is used to request the
|
468
|
-
*
|
880
|
+
* retrieval of a third party transaction request.
|
881
|
+
*
|
469
882
|
*/
|
470
883
|
get: operations["GetThirdpartyTransactionRequests"];
|
471
884
|
/**
|
472
885
|
* UpdateThirdPartyTransactionRequests
|
473
886
|
* @description The HTTP request `PUT /thirdpartyRequests/transactions/{ID}` is used by the DFSP to inform the client about
|
474
|
-
*
|
887
|
+
* the status of a previously requested thirdparty transaction request.
|
888
|
+
*
|
889
|
+
* Switch(Thirdparty API Adapter) -> PISP
|
475
890
|
*
|
476
|
-
* Switch(Thirdparty API Adapter) -> PISP
|
477
891
|
*/
|
478
892
|
put: operations["UpdateThirdPartyTransactionRequests"];
|
893
|
+
post?: never;
|
894
|
+
delete?: never;
|
895
|
+
options?: never;
|
896
|
+
head?: never;
|
479
897
|
/**
|
480
898
|
* NotifyThirdpartyTransactionRequests
|
481
899
|
* @description The HTTP request `PATCH /thirdpartyRequests/transactions/{ID}` is used to
|
482
|
-
*
|
900
|
+
* notify a thirdparty of the outcome of a transaction request.
|
901
|
+
*
|
902
|
+
* Switch(Thirdparty API Adapter) -> PISP
|
483
903
|
*
|
484
|
-
* Switch(Thirdparty API Adapter) -> PISP
|
485
904
|
*/
|
486
905
|
patch: operations["NotifyThirdpartyTransactionRequests"];
|
906
|
+
trace?: never;
|
907
|
+
};
|
908
|
+
"/thirdpartyRequests/transactions/{ID}/error": {
|
487
909
|
parameters: {
|
910
|
+
query?: never;
|
488
911
|
header: {
|
912
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
489
913
|
"Content-Type": components["parameters"]["Content-Type"];
|
914
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
490
915
|
Date: components["parameters"]["Date"];
|
916
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
917
|
+
*
|
918
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
491
919
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
920
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
492
921
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
922
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
493
923
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
924
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
494
925
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
926
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
495
927
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
928
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
496
929
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
930
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
497
931
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
498
932
|
};
|
499
933
|
path: {
|
934
|
+
/** @description The identifier value. */
|
500
935
|
ID: components["parameters"]["ID"];
|
501
936
|
};
|
937
|
+
cookie?: never;
|
502
938
|
};
|
503
|
-
|
504
|
-
"/thirdpartyRequests/transactions/{ID}/error": {
|
939
|
+
get?: never;
|
505
940
|
/**
|
506
941
|
* ThirdpartyTransactionRequestsError
|
507
942
|
* @description If the server is unable to find the transaction request, or another processing error occurs,
|
508
|
-
*
|
509
|
-
*
|
510
|
-
*
|
943
|
+
* the error callback `PUT /thirdpartyRequests/transactions/{ID}/error` is used.
|
944
|
+
* The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of
|
945
|
+
* the thirdparty transaction request.
|
946
|
+
*
|
511
947
|
*/
|
512
948
|
put: operations["ThirdpartyTransactionRequestsError"];
|
949
|
+
post?: never;
|
950
|
+
delete?: never;
|
951
|
+
options?: never;
|
952
|
+
head?: never;
|
953
|
+
patch?: never;
|
954
|
+
trace?: never;
|
955
|
+
};
|
956
|
+
"/thirdpartyRequests/authorizations": {
|
513
957
|
parameters: {
|
958
|
+
query?: never;
|
514
959
|
header: {
|
960
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
515
961
|
"Content-Type": components["parameters"]["Content-Type"];
|
962
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
516
963
|
Date: components["parameters"]["Date"];
|
964
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
965
|
+
*
|
966
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
517
967
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
968
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
518
969
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
970
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
519
971
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
972
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
520
973
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
974
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
521
975
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
976
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
522
977
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
978
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
523
979
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
524
980
|
};
|
525
|
-
path
|
526
|
-
|
527
|
-
};
|
981
|
+
path?: never;
|
982
|
+
cookie?: never;
|
528
983
|
};
|
529
|
-
|
530
|
-
|
984
|
+
get?: never;
|
985
|
+
put?: never;
|
531
986
|
/**
|
532
987
|
* PostThirdpartyRequestsAuthorizations
|
533
988
|
* @description The HTTP request **POST /thirdpartyRequests/authorizations** is used to request the validation by a customer for the transfer described in the request.
|
989
|
+
*
|
534
990
|
*/
|
535
991
|
post: operations["PostThirdpartyRequestsAuthorizations"];
|
992
|
+
delete?: never;
|
993
|
+
options?: never;
|
994
|
+
head?: never;
|
995
|
+
patch?: never;
|
996
|
+
trace?: never;
|
997
|
+
};
|
998
|
+
"/thirdpartyRequests/authorizations/{ID}": {
|
536
999
|
parameters: {
|
1000
|
+
query?: never;
|
537
1001
|
header: {
|
1002
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
538
1003
|
"Content-Type": components["parameters"]["Content-Type"];
|
1004
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
539
1005
|
Date: components["parameters"]["Date"];
|
1006
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
1007
|
+
*
|
1008
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
540
1009
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1010
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
541
1011
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1012
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
542
1013
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1014
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
543
1015
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1016
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
544
1017
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1018
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
545
1019
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1020
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
546
1021
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
547
1022
|
};
|
1023
|
+
path: {
|
1024
|
+
/** @description The identifier value. */
|
1025
|
+
ID: components["parameters"]["ID"];
|
1026
|
+
};
|
1027
|
+
cookie?: never;
|
548
1028
|
};
|
549
|
-
};
|
550
|
-
"/thirdpartyRequests/authorizations/{ID}": {
|
551
1029
|
/**
|
552
1030
|
* GetThirdpartyRequestsAuthorizationsById
|
553
1031
|
* @description The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating
|
554
|
-
*
|
555
|
-
*
|
1032
|
+
* to a previously issued authorization request. The *{ID}* in the request should match the
|
1033
|
+
* `authorizationRequestId` which was given when the authorization request was created.
|
1034
|
+
*
|
556
1035
|
*/
|
557
1036
|
get: operations["GetThirdpartyRequestsAuthorizationsById"];
|
558
1037
|
/**
|
559
1038
|
* PutThirdpartyRequestsAuthorizationsById
|
560
1039
|
* @description After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the
|
561
|
-
*
|
562
|
-
*
|
1040
|
+
* transaction to their user, and request that the client sign the `challenge` field using the credential
|
1041
|
+
* they previously registered.
|
1042
|
+
*
|
1043
|
+
* The signed challenge will be sent back by the PISP in **PUT /thirdpartyRequests/authorizations/**_{ID}_:
|
563
1044
|
*
|
564
|
-
* The signed challenge will be sent back by the PISP in **PUT /thirdpartyRequests/authorizations/**_{ID}_:
|
565
1045
|
*/
|
566
1046
|
put: operations["PutThirdpartyRequestsAuthorizationsById"];
|
1047
|
+
post?: never;
|
1048
|
+
delete?: never;
|
1049
|
+
options?: never;
|
1050
|
+
head?: never;
|
1051
|
+
patch?: never;
|
1052
|
+
trace?: never;
|
1053
|
+
};
|
1054
|
+
"/thirdpartyRequests/authorizations/{ID}/error": {
|
567
1055
|
parameters: {
|
1056
|
+
query?: never;
|
568
1057
|
header: {
|
1058
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
569
1059
|
"Content-Type": components["parameters"]["Content-Type"];
|
1060
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
570
1061
|
Date: components["parameters"]["Date"];
|
1062
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
1063
|
+
*
|
1064
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
571
1065
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1066
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
572
1067
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1068
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
573
1069
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1070
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
574
1071
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1072
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
575
1073
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1074
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
576
1075
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1076
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
577
1077
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
578
1078
|
};
|
579
1079
|
path: {
|
1080
|
+
/** @description The identifier value. */
|
580
1081
|
ID: components["parameters"]["ID"];
|
581
1082
|
};
|
1083
|
+
cookie?: never;
|
582
1084
|
};
|
583
|
-
|
584
|
-
"/thirdpartyRequests/authorizations/{ID}/error": {
|
1085
|
+
get?: never;
|
585
1086
|
/**
|
586
1087
|
* PutThirdpartyRequestsAuthorizationsByIdAndError
|
587
1088
|
* @description The HTTP request `PUT /thirdpartyRequests/authorizations/{ID}/error` is used by the DFSP or PISP to inform
|
588
|
-
*
|
1089
|
+
* the other party that something went wrong with a Thirdparty Transaction Authorization Request.
|
1090
|
+
*
|
1091
|
+
* The PISP may use this to tell the DFSP that the Thirdparty Transaction Authorization Request is invalid or doesn't
|
1092
|
+
* match a `transactionRequestId`.
|
589
1093
|
*
|
590
|
-
*
|
591
|
-
*
|
1094
|
+
* The DFSP may use this to tell the PISP that the signed challenge returned in `PUT /thirdpartyRequest/authorizations/{ID}`
|
1095
|
+
* was invalid.
|
592
1096
|
*
|
593
|
-
* The DFSP may use this to tell the PISP that the signed challenge returned in `PUT /thirdpartyRequest/authorizations/{ID}`
|
594
|
-
* was invalid.
|
595
1097
|
*/
|
596
1098
|
put: operations["PutThirdpartyRequestsAuthorizationsByIdAndError"];
|
1099
|
+
post?: never;
|
1100
|
+
delete?: never;
|
1101
|
+
options?: never;
|
1102
|
+
head?: never;
|
1103
|
+
patch?: never;
|
1104
|
+
trace?: never;
|
1105
|
+
};
|
1106
|
+
"/thirdpartyRequests/verifications": {
|
597
1107
|
parameters: {
|
1108
|
+
query?: never;
|
598
1109
|
header: {
|
1110
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
599
1111
|
"Content-Type": components["parameters"]["Content-Type"];
|
1112
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
600
1113
|
Date: components["parameters"]["Date"];
|
1114
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
1115
|
+
*
|
1116
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
601
1117
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1118
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
602
1119
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1120
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
603
1121
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1122
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
604
1123
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1124
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
605
1125
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1126
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
606
1127
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1128
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
607
1129
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
608
1130
|
};
|
609
|
-
path
|
610
|
-
|
611
|
-
};
|
1131
|
+
path?: never;
|
1132
|
+
cookie?: never;
|
612
1133
|
};
|
613
|
-
|
614
|
-
|
1134
|
+
get?: never;
|
1135
|
+
put?: never;
|
615
1136
|
/**
|
616
1137
|
* PostThirdpartyRequestsVerifications
|
617
1138
|
* @description The HTTP request `POST /thirdpartyRequests/verifications` is used by the DFSP to verify a third party authorization.
|
1139
|
+
*
|
618
1140
|
*/
|
619
1141
|
post: operations["PostThirdpartyRequestsVerifications"];
|
1142
|
+
delete?: never;
|
1143
|
+
options?: never;
|
1144
|
+
head?: never;
|
1145
|
+
patch?: never;
|
1146
|
+
trace?: never;
|
1147
|
+
};
|
1148
|
+
"/thirdpartyRequests/verifications/{ID}": {
|
620
1149
|
parameters: {
|
1150
|
+
query?: never;
|
621
1151
|
header: {
|
1152
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
622
1153
|
"Content-Type": components["parameters"]["Content-Type"];
|
1154
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
623
1155
|
Date: components["parameters"]["Date"];
|
1156
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
1157
|
+
*
|
1158
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
624
1159
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1160
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
625
1161
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1162
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
626
1163
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1164
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
627
1165
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1166
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
628
1167
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1168
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
629
1169
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1170
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
630
1171
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
631
1172
|
};
|
1173
|
+
path: {
|
1174
|
+
/** @description The identifier value. */
|
1175
|
+
ID: components["parameters"]["ID"];
|
1176
|
+
};
|
1177
|
+
cookie?: never;
|
632
1178
|
};
|
633
|
-
};
|
634
|
-
"/thirdpartyRequests/verifications/{ID}": {
|
635
1179
|
/**
|
636
1180
|
* GetThirdpartyRequestsVerificationsById
|
637
1181
|
* @description The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get
|
638
|
-
*
|
639
|
-
*
|
1182
|
+
* information regarding a previously created or requested authorization. The *{ID}*
|
1183
|
+
* in the URI should contain the verification request ID
|
1184
|
+
*
|
640
1185
|
*/
|
641
1186
|
get: operations["GetThirdpartyRequestsVerificationsById"];
|
642
1187
|
/**
|
643
1188
|
* PutThirdpartyRequestsVerificationsById
|
644
1189
|
* @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
|
645
|
-
*
|
646
|
-
*
|
1190
|
+
* If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`.
|
1191
|
+
* In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
|
647
1192
|
*/
|
648
1193
|
put: operations["PutThirdpartyRequestsVerificationsById"];
|
1194
|
+
post?: never;
|
1195
|
+
delete?: never;
|
1196
|
+
options?: never;
|
1197
|
+
head?: never;
|
1198
|
+
patch?: never;
|
1199
|
+
trace?: never;
|
1200
|
+
};
|
1201
|
+
"/thirdpartyRequests/verifications/{ID}/error": {
|
649
1202
|
parameters: {
|
1203
|
+
query?: never;
|
650
1204
|
header: {
|
1205
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
651
1206
|
"Content-Type": components["parameters"]["Content-Type"];
|
1207
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
652
1208
|
Date: components["parameters"]["Date"];
|
1209
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
1210
|
+
*
|
1211
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
653
1212
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1213
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
654
1214
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1215
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
655
1216
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1217
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
656
1218
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1219
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
657
1220
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1221
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
658
1222
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1223
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
659
1224
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
660
1225
|
};
|
661
1226
|
path: {
|
1227
|
+
/** @description The identifier value. */
|
662
1228
|
ID: components["parameters"]["ID"];
|
663
1229
|
};
|
1230
|
+
cookie?: never;
|
664
1231
|
};
|
665
|
-
|
666
|
-
"/thirdpartyRequests/verifications/{ID}/error": {
|
1232
|
+
get?: never;
|
667
1233
|
/**
|
668
1234
|
* PutThirdpartyRequestsVerificationsByIdAndError
|
669
1235
|
* @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}/error` is used by the Auth-Service to inform
|
670
|
-
*
|
1236
|
+
* the DFSP of a failure in validating or looking up the verification of a Thirdparty Transaction Request.
|
1237
|
+
*
|
671
1238
|
*/
|
672
1239
|
put: operations["PutThirdpartyRequestsVerificationsByIdAndError"];
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
680
|
-
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
681
|
-
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
682
|
-
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
683
|
-
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
684
|
-
};
|
685
|
-
path: {
|
686
|
-
ID: components["parameters"]["ID"];
|
687
|
-
};
|
688
|
-
};
|
1240
|
+
post?: never;
|
1241
|
+
delete?: never;
|
1242
|
+
options?: never;
|
1243
|
+
head?: never;
|
1244
|
+
patch?: never;
|
1245
|
+
trace?: never;
|
689
1246
|
};
|
690
1247
|
}
|
691
1248
|
export type webhooks = Record<string, never>;
|
@@ -694,48 +1251,48 @@ export interface components {
|
|
694
1251
|
/**
|
695
1252
|
* PartyIdType
|
696
1253
|
* @description Below are the allowed values for the enumeration.
|
697
|
-
*
|
698
|
-
*
|
699
|
-
*
|
700
|
-
*
|
701
|
-
*
|
702
|
-
*
|
703
|
-
*
|
704
|
-
*
|
705
|
-
*
|
706
|
-
*
|
707
|
-
*
|
708
|
-
*
|
709
|
-
*
|
710
|
-
*
|
711
|
-
*
|
712
|
-
*
|
713
|
-
*
|
714
|
-
*
|
715
|
-
*
|
716
|
-
*
|
717
|
-
*
|
718
|
-
*
|
719
|
-
*
|
720
|
-
*
|
721
|
-
*
|
722
|
-
*
|
723
|
-
*
|
724
|
-
*
|
725
|
-
*
|
726
|
-
*
|
727
|
-
*
|
728
|
-
*
|
729
|
-
*
|
730
|
-
*
|
731
|
-
*
|
732
|
-
*
|
733
|
-
*
|
734
|
-
*
|
735
|
-
*
|
736
|
-
*
|
737
|
-
*
|
738
|
-
*
|
1254
|
+
* - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
|
1255
|
+
* Number, that is, the phone number) is used as reference to a participant.
|
1256
|
+
* The MSISDN identifier should be in international format according to the
|
1257
|
+
* [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
|
1258
|
+
* Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
|
1259
|
+
* international prefix.
|
1260
|
+
* - EMAIL - An email is used as reference to a
|
1261
|
+
* participant. The format of the email should be according to the informational
|
1262
|
+
* [RFC 3696](https://tools.ietf.org/html/rfc3696).
|
1263
|
+
* - PERSONAL_ID - A personal identifier is used as reference to a participant.
|
1264
|
+
* Examples of personal identification are passport number, birth certificate
|
1265
|
+
* number, and national registration number. The identifier number is added in
|
1266
|
+
* the PartyIdentifier element. The personal identifier type is added in the
|
1267
|
+
* PartySubIdOrType element.
|
1268
|
+
* - BUSINESS - A specific Business (for example, an organization or a company)
|
1269
|
+
* is used as reference to a participant. The BUSINESS identifier can be in any
|
1270
|
+
* format. To make a transaction connected to a specific username or bill number
|
1271
|
+
* in a Business, the PartySubIdOrType element should be used.
|
1272
|
+
* - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
|
1273
|
+
* specific business or organization is used as reference to a Party.
|
1274
|
+
* For referencing a specific device under a specific business or organization,
|
1275
|
+
* use the PartySubIdOrType element.
|
1276
|
+
* - ACCOUNT_ID - A bank account number or FSP account ID should be used as
|
1277
|
+
* reference to a participant. The ACCOUNT_ID identifier can be in any format,
|
1278
|
+
* as formats can greatly differ depending on country and FSP.
|
1279
|
+
* - IBAN - A bank account number or FSP account ID is used as reference to a
|
1280
|
+
* participant. The IBAN identifier can consist of up to 34 alphanumeric
|
1281
|
+
* characters and should be entered without whitespace.
|
1282
|
+
* - ALIAS An alias is used as reference to a participant. The alias should be
|
1283
|
+
* created in the FSP as an alternative reference to an account owner.
|
1284
|
+
* Another example of an alias is a username in the FSP system.
|
1285
|
+
* The ALIAS identifier can be in any format. It is also possible to use the
|
1286
|
+
* PartySubIdOrType element for identifying an account under an Alias defined
|
1287
|
+
* by the PartyIdentifier.
|
1288
|
+
* - CONSENT - A Consent represents an agreement between a PISP, a Customer and
|
1289
|
+
* a DFSP which allows the PISP permission to perform actions on behalf of the
|
1290
|
+
* customer. A Consent has an authoritative source: either the DFSP who issued
|
1291
|
+
* the Consent, or an Auth Service which administers the Consent.
|
1292
|
+
* - THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP,
|
1293
|
+
* a DFSP, and a specific Customer's account at the DFSP. The content of the link
|
1294
|
+
* is created by the DFSP at the time when it gives permission to the PISP for
|
1295
|
+
* specific access to a given account.
|
739
1296
|
*
|
740
1297
|
* @example PERSONAL_ID
|
741
1298
|
* @enum {string}
|
@@ -902,9 +1459,10 @@ export interface components {
|
|
902
1459
|
* PartiesTypeIDPutResponse
|
903
1460
|
* @description The object sent in the PUT /parties/{Type}/{ID} callback.
|
904
1461
|
*
|
905
|
-
*
|
906
|
-
*
|
907
|
-
*
|
1462
|
+
* This is a variant based on FSPIOP `PartiesTypeIDPutResponse` specification.
|
1463
|
+
* Main difference being that it returns a `Party` with the newly added
|
1464
|
+
* `accounts` property.
|
1465
|
+
*
|
908
1466
|
*/
|
909
1467
|
PartiesTypeIDPutResponse: {
|
910
1468
|
party: components["schemas"]["Party"];
|
@@ -978,10 +1536,10 @@ export interface components {
|
|
978
1536
|
/**
|
979
1537
|
* TransactionRequestState
|
980
1538
|
* @description Below are the allowed values for the enumeration.
|
981
|
-
*
|
982
|
-
*
|
983
|
-
*
|
984
|
-
*
|
1539
|
+
* - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
|
1540
|
+
* - PENDING - Payer FSP has sent the transaction request to the Payer.
|
1541
|
+
* - ACCEPTED - Payer has approved the transaction.
|
1542
|
+
* - REJECTED - Payer has rejected the transaction.
|
985
1543
|
* @example RECEIVED
|
986
1544
|
* @enum {string}
|
987
1545
|
*/
|
@@ -989,10 +1547,10 @@ export interface components {
|
|
989
1547
|
/**
|
990
1548
|
* TransactionState
|
991
1549
|
* @description Below are the allowed values for the enumeration.
|
992
|
-
*
|
993
|
-
*
|
994
|
-
*
|
995
|
-
*
|
1550
|
+
* - RECEIVED - Payee FSP has received the transaction from the Payer FSP.
|
1551
|
+
* - PENDING - Payee FSP has validated the transaction.
|
1552
|
+
* - COMPLETED - Payee FSP has successfully performed the transaction.
|
1553
|
+
* - REJECTED - Payee FSP has failed to perform the transaction.
|
996
1554
|
* @example RECEIVED
|
997
1555
|
* @enum {string}
|
998
1556
|
*/
|
@@ -1000,10 +1558,10 @@ export interface components {
|
|
1000
1558
|
/**
|
1001
1559
|
* ThirdpartyRequestsTransactionsIDPatchResponse
|
1002
1560
|
* @description Used by: DFSP
|
1003
|
-
*
|
1004
|
-
*
|
1005
|
-
*
|
1006
|
-
*
|
1561
|
+
* The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer.
|
1562
|
+
* This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource.
|
1563
|
+
* The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request.
|
1564
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
1007
1565
|
*/
|
1008
1566
|
ThirdpartyRequestsTransactionsIDPatchResponse: {
|
1009
1567
|
completedTimestamp?: components["schemas"]["DateTime"];
|
@@ -1014,7 +1572,7 @@ export interface components {
|
|
1014
1572
|
/**
|
1015
1573
|
* AuthorizationResponseType
|
1016
1574
|
* @description Enum containing authorization response information; if the customer
|
1017
|
-
*
|
1575
|
+
* accepted the terms of the transfer, or rejected the terms.
|
1018
1576
|
*
|
1019
1577
|
* @enum {string}
|
1020
1578
|
*/
|
@@ -1022,7 +1580,7 @@ export interface components {
|
|
1022
1580
|
/**
|
1023
1581
|
* ConsentStatusIssued
|
1024
1582
|
* @description Allowed values for the enumeration ConsentStatus
|
1025
|
-
*
|
1583
|
+
* - ISSUED - The consent has been issued by the DFSP
|
1026
1584
|
* @enum {string}
|
1027
1585
|
*/
|
1028
1586
|
ConsentStatusIssued: "ISSUED";
|
@@ -1065,8 +1623,8 @@ export interface components {
|
|
1065
1623
|
/**
|
1066
1624
|
* ServiceType
|
1067
1625
|
* @description The ServiceType enumeration describes the types of role for which a DFSP may query using the /services resource.
|
1068
|
-
*
|
1069
|
-
*
|
1626
|
+
* Below are the allowed values for the enumeration ServiceType - THIRD_PARTY_DFSP - Enum used to query for DFSPs that have thirdparty features enabled. - PISP - Enum used to query for PISPs. - AUTH_SERVICE - Participants which provide Authentication Services.
|
1627
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
|
1070
1628
|
* @enum {string}
|
1071
1629
|
*/
|
1072
1630
|
ServiceType: "THIRD_PARTY_DFSP" | "PISP" | "AUTH_SERVICE";
|
@@ -1082,18 +1640,17 @@ export interface components {
|
|
1082
1640
|
*/
|
1083
1641
|
ParticipantsPostRequest: {
|
1084
1642
|
requestId: components["schemas"]["CorrelationId"];
|
1085
|
-
/**
|
1086
|
-
*
|
1087
|
-
*
|
1088
|
-
*/
|
1643
|
+
/** @description List of PartyIdInfo elements that the client would like to update
|
1644
|
+
* or create FSP information about.
|
1645
|
+
* */
|
1089
1646
|
partyList: components["schemas"]["PartyIdInfo"][];
|
1090
1647
|
currency?: components["schemas"]["Currency"];
|
1091
1648
|
};
|
1092
1649
|
/**
|
1093
1650
|
* AmountType
|
1094
1651
|
* @description Below are the allowed values for the enumeration AmountType.
|
1095
|
-
*
|
1096
|
-
*
|
1652
|
+
* - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
1653
|
+
* - 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.
|
1097
1654
|
* @example RECEIVE
|
1098
1655
|
* @enum {string}
|
1099
1656
|
*/
|
@@ -1101,11 +1658,11 @@ export interface components {
|
|
1101
1658
|
/**
|
1102
1659
|
* TransactionScenario
|
1103
1660
|
* @description Below are the allowed values for the enumeration.
|
1104
|
-
*
|
1105
|
-
*
|
1106
|
-
*
|
1107
|
-
*
|
1108
|
-
*
|
1661
|
+
* - DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.
|
1662
|
+
* - WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.
|
1663
|
+
* - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
1664
|
+
* - PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.
|
1665
|
+
* - REFUND - Used for performing a refund of transaction.
|
1109
1666
|
* @example DEPOSIT
|
1110
1667
|
* @enum {string}
|
1111
1668
|
*/
|
@@ -1119,8 +1676,8 @@ export interface components {
|
|
1119
1676
|
/**
|
1120
1677
|
* TransactionInitiator
|
1121
1678
|
* @description Below are the allowed values for the enumeration.
|
1122
|
-
*
|
1123
|
-
*
|
1679
|
+
* - PAYER - Sender of funds is initiating the transaction. The account to send from is either owned by the Payer or is connected to the Payer in some way.
|
1680
|
+
* - PAYEE - Recipient of the funds is initiating the transaction by sending a transaction request. The Payer must approve the transaction, either automatically by a pre-generated OTP or by pre-approval of the Payee, or by manually approving in his or her own Device.
|
1124
1681
|
* @example PAYEE
|
1125
1682
|
* @enum {string}
|
1126
1683
|
*/
|
@@ -1128,10 +1685,10 @@ export interface components {
|
|
1128
1685
|
/**
|
1129
1686
|
* TransactionInitiatorType
|
1130
1687
|
* @description Below are the allowed values for the enumeration.
|
1131
|
-
*
|
1132
|
-
*
|
1133
|
-
*
|
1134
|
-
*
|
1688
|
+
* - CONSUMER - Consumer is the initiator of the transaction.
|
1689
|
+
* - AGENT - Agent is the initiator of the transaction.
|
1690
|
+
* - BUSINESS - Business is the initiator of the transaction.
|
1691
|
+
* - DEVICE - Device is the initiator of the transaction.
|
1135
1692
|
* @example CONSUMER
|
1136
1693
|
* @enum {string}
|
1137
1694
|
*/
|
@@ -1229,25 +1786,25 @@ export interface components {
|
|
1229
1786
|
* Name
|
1230
1787
|
* @description The API data type Name is a JSON String, restricted by a regular expression to avoid characters which are generally not used in a name.
|
1231
1788
|
*
|
1232
|
-
*
|
1789
|
+
* Regular Expression - The regular expression for restricting the Name type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a string consisting of whitespace only, all Unicode characters are allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,) and space characters ( ).
|
1233
1790
|
*
|
1234
|
-
*
|
1791
|
+
* **Note:** In some programming languages, Unicode support must be specifically enabled. For example, if Java is used, the flag UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
|
1235
1792
|
*/
|
1236
1793
|
Name: string;
|
1237
1794
|
/**
|
1238
1795
|
* AccountAddress
|
1239
1796
|
* @description The AccountAddress data type is a variable length string with a maximum size of 1023 characters and consists of:
|
1240
|
-
*
|
1241
|
-
*
|
1242
|
-
*
|
1243
|
-
*
|
1244
|
-
*
|
1797
|
+
* Alphanumeric characters, upper or lower case. (Addresses are case-sensitive so that they can contain data encoded in formats such as base64url.)
|
1798
|
+
* - Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character
|
1799
|
+
* An entity providing accounts to parties (i.e. a participant) can provide any value for an AccountAddress that is meaningful to that entity. It does not need to provide an address that makes the account identifiable outside the entity's domain.
|
1800
|
+
* IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case).
|
1801
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
1245
1802
|
*/
|
1246
1803
|
AccountAddress: string;
|
1247
1804
|
/**
|
1248
1805
|
* Account
|
1249
1806
|
* @description Data model for the complex type Account.
|
1250
|
-
*
|
1807
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
1251
1808
|
*/
|
1252
1809
|
Account: {
|
1253
1810
|
accountNickname: components["schemas"]["Name"];
|
@@ -1257,15 +1814,15 @@ export interface components {
|
|
1257
1814
|
/**
|
1258
1815
|
* AccountList
|
1259
1816
|
* @description The AccountList data model is used to hold information about the accounts that a party controls.
|
1260
|
-
*
|
1817
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
1261
1818
|
*/
|
1262
1819
|
AccountList: components["schemas"]["Account"][];
|
1263
1820
|
/**
|
1264
1821
|
* AccountsIDPutResponse
|
1265
1822
|
* @description Callback and data model information for GET /accounts/{ID}:
|
1266
|
-
*
|
1267
|
-
*
|
1268
|
-
*
|
1823
|
+
* Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body
|
1824
|
+
* The PUT /accounts/{ID} response is used to inform the requester of the result of a request for accounts information. The identifier ID given in the call are the values given in the original request.
|
1825
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
1269
1826
|
*/
|
1270
1827
|
AccountsIDPutResponse: {
|
1271
1828
|
accounts: components["schemas"]["AccountList"];
|
@@ -1281,12 +1838,12 @@ export interface components {
|
|
1281
1838
|
/**
|
1282
1839
|
* ScopeAction
|
1283
1840
|
* @description The ScopeAction element contains an access type which a PISP can request
|
1284
|
-
*
|
1285
|
-
*
|
1841
|
+
* from a DFSP, or which a DFSP can grant to a PISP.
|
1842
|
+
* It must be a member of the appropriate enumeration.
|
1286
1843
|
*
|
1287
|
-
*
|
1288
|
-
*
|
1289
|
-
*
|
1844
|
+
* - ACCOUNTS_GET_BALANCE: PISP can request a balance for the linked account
|
1845
|
+
* - ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the linked account in the DFSP
|
1846
|
+
* - ACCOUNTS_STATEMENT: PISP can request a statement of individual transactions on a user's account
|
1290
1847
|
*
|
1291
1848
|
* @enum {string}
|
1292
1849
|
*/
|
@@ -1294,7 +1851,7 @@ export interface components {
|
|
1294
1851
|
/**
|
1295
1852
|
* Scope
|
1296
1853
|
* @description The Scope element contains an identifier defining, in the terms of a DFSP, an account on which access types can be requested or granted. It also defines the access types which are requested or granted.
|
1297
|
-
*
|
1854
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
1298
1855
|
*/
|
1299
1856
|
Scope: {
|
1300
1857
|
address: components["schemas"]["AccountAddress"];
|
@@ -1303,8 +1860,8 @@ export interface components {
|
|
1303
1860
|
/**
|
1304
1861
|
* ConsentRequestChannelType
|
1305
1862
|
* @description The auth channel being used for the consent request.
|
1306
|
-
*
|
1307
|
-
*
|
1863
|
+
* - WEB - DFSP can support authorization via a web-based login.
|
1864
|
+
* - OTP - DFSP can support authorization via a One Time PIN.
|
1308
1865
|
*
|
1309
1866
|
* @enum {string}
|
1310
1867
|
*/
|
@@ -1312,15 +1869,16 @@ export interface components {
|
|
1312
1869
|
/**
|
1313
1870
|
* Uri
|
1314
1871
|
* @description The API data type Uri is a JSON string in a canonical format that is restricted by a regular expression for interoperability reasons.
|
1872
|
+
*
|
1315
1873
|
*/
|
1316
1874
|
Uri: string;
|
1317
1875
|
/**
|
1318
1876
|
* ConsentRequestsPostRequest
|
1319
1877
|
* @description Used by: PISP
|
1320
|
-
*
|
1321
|
-
*
|
1322
|
-
*
|
1323
|
-
*
|
1878
|
+
* The HTTP request POST /consentRequests is used to request a DFSP to grant access to one or more accounts owned by a customer of the DFSP for the PISP who sends the request.
|
1879
|
+
* Callback and data model for POST /consentRequests:
|
1880
|
+
* Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url
|
1881
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
1324
1882
|
*/
|
1325
1883
|
ConsentRequestsPostRequest: {
|
1326
1884
|
consentRequestId: components["schemas"]["CorrelationId"];
|
@@ -1342,10 +1900,11 @@ export interface components {
|
|
1342
1900
|
* ConsentRequestsIDPutResponseWeb
|
1343
1901
|
* @description The object sent in a `PUT /consentRequests/{ID}` request.
|
1344
1902
|
*
|
1345
|
-
*
|
1346
|
-
*
|
1347
|
-
*
|
1348
|
-
*
|
1903
|
+
* Schema used in the request consent phase of the account linking web flow,
|
1904
|
+
* the result is the PISP being instructed on a specific URL where this
|
1905
|
+
* supposed user should be redirected. This URL should be a place where
|
1906
|
+
* the user can prove their identity (e.g., by logging in).
|
1907
|
+
*
|
1349
1908
|
*/
|
1350
1909
|
ConsentRequestsIDPutResponseWeb: {
|
1351
1910
|
scopes: components["schemas"]["Scope"][];
|
@@ -1365,7 +1924,8 @@ export interface components {
|
|
1365
1924
|
* ConsentRequestsIDPutResponseOTP
|
1366
1925
|
* @description The object sent in a `PUT /consentRequests/{ID}` request.
|
1367
1926
|
*
|
1368
|
-
*
|
1927
|
+
* Schema used in the request consent phase of the account linking OTP/SMS flow.
|
1928
|
+
*
|
1369
1929
|
*/
|
1370
1930
|
ConsentRequestsIDPutResponseOTP: {
|
1371
1931
|
scopes: components["schemas"]["Scope"][];
|
@@ -1378,8 +1938,8 @@ export interface components {
|
|
1378
1938
|
/**
|
1379
1939
|
* ConsentRequestsIDPatchRequest
|
1380
1940
|
* @description Used by: PISP
|
1381
|
-
*
|
1382
|
-
*
|
1941
|
+
* After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
|
1942
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
1383
1943
|
*/
|
1384
1944
|
ConsentRequestsIDPatchRequest: {
|
1385
1945
|
authToken: components["schemas"]["BinaryString"];
|
@@ -1388,14 +1948,14 @@ export interface components {
|
|
1388
1948
|
/**
|
1389
1949
|
* CredentialType
|
1390
1950
|
* @description The type of the Credential. - "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object. - "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object.
|
1391
|
-
*
|
1951
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
1392
1952
|
* @enum {string}
|
1393
1953
|
*/
|
1394
1954
|
CredentialType: "FIDO" | "GENERIC";
|
1395
1955
|
/**
|
1396
1956
|
* CredentialStatusPending
|
1397
1957
|
* @description The status of the Credential.
|
1398
|
-
*
|
1958
|
+
* - "PENDING" - The credential has been created, but has not been verified
|
1399
1959
|
*
|
1400
1960
|
* @enum {string}
|
1401
1961
|
*/
|
@@ -1403,6 +1963,7 @@ export interface components {
|
|
1403
1963
|
/**
|
1404
1964
|
* GenericCredential
|
1405
1965
|
* @description A publicKey + signature of a challenge for a generic public/private keypair.
|
1966
|
+
*
|
1406
1967
|
*/
|
1407
1968
|
GenericCredential: {
|
1408
1969
|
publicKey: components["schemas"]["BinaryString"];
|
@@ -1411,25 +1972,29 @@ export interface components {
|
|
1411
1972
|
/**
|
1412
1973
|
* FIDOPublicKeyCredentialAttestation
|
1413
1974
|
* @description A data model representing a FIDO Attestation result. Derived from
|
1414
|
-
*
|
1975
|
+
* [`PublicKeyCredential` Interface](https://w3c.github.io/webauthn/#iface-pkcredential).
|
1976
|
+
*
|
1977
|
+
* The `PublicKeyCredential` interface represents the below fields with
|
1978
|
+
* a Type of Javascript [ArrayBuffer](https://heycam.github.io/webidl/#idl-ArrayBuffer).
|
1979
|
+
* For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
1415
1980
|
*
|
1416
|
-
* The `PublicKeyCredential` interface represents the below fields with
|
1417
|
-
* a Type of Javascript [ArrayBuffer](https://heycam.github.io/webidl/#idl-ArrayBuffer).
|
1418
|
-
* For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
1419
1981
|
*/
|
1420
1982
|
FIDOPublicKeyCredentialAttestation: {
|
1421
|
-
/**
|
1422
|
-
*
|
1423
|
-
*
|
1424
|
-
*/
|
1983
|
+
/** @description credential id: identifier of pair of keys, base64 encoded
|
1984
|
+
* https://w3c.github.io/webauthn/#ref-for-dom-credential-id
|
1985
|
+
* */
|
1425
1986
|
id: string;
|
1426
|
-
/** @description raw credential id: identifier of pair of keys, base64 encoded
|
1987
|
+
/** @description raw credential id: identifier of pair of keys, base64 encoded
|
1988
|
+
* */
|
1427
1989
|
rawId?: string;
|
1428
|
-
/** @description AuthenticatorAttestationResponse
|
1990
|
+
/** @description AuthenticatorAttestationResponse
|
1991
|
+
* */
|
1429
1992
|
response: {
|
1430
|
-
/** @description JSON string with client data
|
1993
|
+
/** @description JSON string with client data
|
1994
|
+
* */
|
1431
1995
|
clientDataJSON: string;
|
1432
|
-
/** @description CBOR.encoded attestation object
|
1996
|
+
/** @description CBOR.encoded attestation object
|
1997
|
+
* */
|
1433
1998
|
attestationObject: string;
|
1434
1999
|
};
|
1435
2000
|
/**
|
@@ -1441,11 +2006,12 @@ export interface components {
|
|
1441
2006
|
/**
|
1442
2007
|
* SignedCredential
|
1443
2008
|
* @description A credential used to allow a user to prove their identity and access
|
1444
|
-
*
|
2009
|
+
* to an account with a DFSP.
|
2010
|
+
*
|
2011
|
+
* SignedCredential is a special formatting of the credential to allow us to be
|
2012
|
+
* more explicit about the `status` field - it should only ever be PENDING when
|
2013
|
+
* updating a credential.
|
1445
2014
|
*
|
1446
|
-
* SignedCredential is a special formatting of the credential to allow us to be
|
1447
|
-
* more explicit about the `status` field - it should only ever be PENDING when
|
1448
|
-
* updating a credential.
|
1449
2015
|
*/
|
1450
2016
|
SignedCredential: {
|
1451
2017
|
credentialType: components["schemas"]["CredentialType"];
|
@@ -1456,21 +2022,21 @@ export interface components {
|
|
1456
2022
|
/**
|
1457
2023
|
* ConsentStatus
|
1458
2024
|
* @description Allowed values for the enumeration ConsentStatus
|
1459
|
-
*
|
1460
|
-
*
|
2025
|
+
* - ISSUED - The consent has been issued by the DFSP
|
2026
|
+
* - REVOKED - The consent has been revoked
|
1461
2027
|
* @enum {string}
|
1462
2028
|
*/
|
1463
2029
|
ConsentStatus: "ISSUED" | "REVOKED";
|
1464
2030
|
/**
|
1465
2031
|
* ConsentPostRequestAUTH
|
1466
2032
|
* @description The object sent in a `POST /consents` request to the Auth-Service
|
1467
|
-
*
|
2033
|
+
* by a DFSP to store registered Consent and credential
|
2034
|
+
*
|
1468
2035
|
*/
|
1469
2036
|
ConsentsPostRequestAUTH: {
|
1470
|
-
/**
|
1471
|
-
*
|
1472
|
-
*
|
1473
|
-
*/
|
2037
|
+
/** @description Common ID between the PISP and FSP for the Consent object
|
2038
|
+
* determined by the DFSP who creates the Consent.
|
2039
|
+
* */
|
1474
2040
|
consentId: components["schemas"]["CorrelationId"];
|
1475
2041
|
consentRequestId?: components["schemas"]["CorrelationId"];
|
1476
2042
|
scopes: components["schemas"]["Scope"][];
|
@@ -1481,15 +2047,16 @@ export interface components {
|
|
1481
2047
|
/**
|
1482
2048
|
* ConsentPostRequestPISP
|
1483
2049
|
* @description The provisional Consent object sent by the DFSP in `POST /consents`.
|
2050
|
+
*
|
1484
2051
|
*/
|
1485
2052
|
ConsentsPostRequestPISP: {
|
1486
|
-
/**
|
1487
|
-
*
|
1488
|
-
*
|
1489
|
-
*
|
1490
|
-
*/
|
2053
|
+
/** @description Common ID between the PISP and the Payer DFSP for the consent object. The ID
|
2054
|
+
* should be reused for re-sends of the same consent. A new ID should be generated
|
2055
|
+
* for each new consent.
|
2056
|
+
* */
|
1491
2057
|
consentId: components["schemas"]["CorrelationId"];
|
1492
|
-
/** @description The ID given to the original consent request on which this consent is based.
|
2058
|
+
/** @description The ID given to the original consent request on which this consent is based.
|
2059
|
+
* */
|
1493
2060
|
consentRequestId: components["schemas"]["CorrelationId"];
|
1494
2061
|
scopes: components["schemas"]["Scope"][];
|
1495
2062
|
status: components["schemas"]["ConsentStatus"];
|
@@ -1498,7 +2065,8 @@ export interface components {
|
|
1498
2065
|
/**
|
1499
2066
|
* ConsentsIDPutResponseSigned
|
1500
2067
|
* @description The HTTP request `PUT /consents/{ID}` is used by the PISP to update a Consent with a signed challenge and register a credential.
|
1501
|
-
*
|
2068
|
+
* Called by a `PISP` to after signing a challenge. Sent to a DFSP for verification.
|
2069
|
+
*
|
1502
2070
|
*/
|
1503
2071
|
ConsentsIDPutResponseSigned: {
|
1504
2072
|
status?: components["schemas"]["ConsentStatusIssued"];
|
@@ -1509,7 +2077,7 @@ export interface components {
|
|
1509
2077
|
/**
|
1510
2078
|
* CredentialStatusVerified
|
1511
2079
|
* @description The status of the Credential.
|
1512
|
-
*
|
2080
|
+
* - "VERIFIED" - The Credential is valid and verified.
|
1513
2081
|
*
|
1514
2082
|
* @enum {string}
|
1515
2083
|
*/
|
@@ -1517,11 +2085,12 @@ export interface components {
|
|
1517
2085
|
/**
|
1518
2086
|
* VerifiedCredential
|
1519
2087
|
* @description A credential used to allow a user to prove their identity and access
|
1520
|
-
*
|
2088
|
+
* to an account with a DFSP.
|
2089
|
+
*
|
2090
|
+
* VerifiedCredential is a special formatting of Credential to allow us to be
|
2091
|
+
* more explicit about the `status` field - it should only ever be VERIFIED when
|
2092
|
+
* updating a credential.
|
1521
2093
|
*
|
1522
|
-
* VerifiedCredential is a special formatting of Credential to allow us to be
|
1523
|
-
* more explicit about the `status` field - it should only ever be VERIFIED when
|
1524
|
-
* updating a credential.
|
1525
2094
|
*/
|
1526
2095
|
VerifiedCredential: {
|
1527
2096
|
credentialType: components["schemas"]["CredentialType"];
|
@@ -1532,7 +2101,8 @@ export interface components {
|
|
1532
2101
|
/**
|
1533
2102
|
* ConsentsIDPutResponseVerified
|
1534
2103
|
* @description The HTTP request `PUT /consents/{ID}` is used by the DFSP or Auth-Service to update a Consent object once it has been Verified.
|
1535
|
-
*
|
2104
|
+
* Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
|
2105
|
+
*
|
1536
2106
|
*/
|
1537
2107
|
ConsentsIDPutResponseVerified: {
|
1538
2108
|
status?: components["schemas"]["ConsentStatusIssued"];
|
@@ -1544,8 +2114,9 @@ export interface components {
|
|
1544
2114
|
* ConsentsIDPatchResponseVerified
|
1545
2115
|
* @description PATCH /consents/{ID} request object.
|
1546
2116
|
*
|
1547
|
-
*
|
1548
|
-
*
|
2117
|
+
* Sent by the DFSP to the PISP when a consent is issued and verified.
|
2118
|
+
* Used in the "Register Credential" part of the Account linking flow.
|
2119
|
+
*
|
1549
2120
|
*/
|
1550
2121
|
ConsentsIDPatchResponseVerified: {
|
1551
2122
|
credential: {
|
@@ -1556,7 +2127,7 @@ export interface components {
|
|
1556
2127
|
/**
|
1557
2128
|
* ConsentStatusRevoked
|
1558
2129
|
* @description Allowed values for the enumeration ConsentStatus
|
1559
|
-
*
|
2130
|
+
* - REVOKED - The consent has been revoked
|
1560
2131
|
* @enum {string}
|
1561
2132
|
*/
|
1562
2133
|
ConsentStatusRevoked: "REVOKED";
|
@@ -1564,8 +2135,9 @@ export interface components {
|
|
1564
2135
|
* ConsentsIDPatchResponseRevoked
|
1565
2136
|
* @description PATCH /consents/{ID} request object.
|
1566
2137
|
*
|
1567
|
-
*
|
1568
|
-
*
|
2138
|
+
* Sent to both the PISP and DFSP when a consent is revoked.
|
2139
|
+
* Used in the "Unlinking" part of the Account Unlinking flow.
|
2140
|
+
*
|
1569
2141
|
*/
|
1570
2142
|
ConsentsIDPatchResponseRevoked: {
|
1571
2143
|
status: components["schemas"]["ConsentStatusRevoked"];
|
@@ -1591,10 +2163,10 @@ export interface components {
|
|
1591
2163
|
/**
|
1592
2164
|
* ServicesServiceTypePutResponse
|
1593
2165
|
* @description Used by: Switch
|
1594
|
-
*
|
1595
|
-
*
|
1596
|
-
*
|
1597
|
-
*
|
2166
|
+
* The callback PUT /services/{ServiceType} is used to inform the client of a successful result of the service information lookup.
|
2167
|
+
* Callback and data model information for GET /services/{ServiceType}:
|
2168
|
+
* Callback - PUT /services/{ServiceType} Error Callback - PUT /services/{ServiceType}/error Data Model - Empty body
|
2169
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
|
1598
2170
|
*/
|
1599
2171
|
ServicesServiceTypePutResponse: {
|
1600
2172
|
providers: components["schemas"]["FspId"][];
|
@@ -1603,13 +2175,14 @@ export interface components {
|
|
1603
2175
|
/**
|
1604
2176
|
* ThirdpartyRequestsTransactionsPostRequest
|
1605
2177
|
* @description Used by: PISP
|
1606
|
-
*
|
1607
|
-
*
|
1608
|
-
*
|
1609
|
-
*
|
2178
|
+
* The HTTP request POST /thirdpartyRequests/transactions is used to request the creation of a transaction request on the server for the transfer described in the request.
|
2179
|
+
* Callback and data model information for POST /thirdpartyRequests/transactions:
|
2180
|
+
* Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below
|
2181
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
1610
2182
|
*/
|
1611
2183
|
ThirdpartyRequestsTransactionsPostRequest: {
|
1612
|
-
/** @description Common ID between the PISP and the Payer DFSP for the transaction request object. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request.
|
2184
|
+
/** @description Common ID between the PISP and the Payer DFSP for the transaction request object. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request.
|
2185
|
+
* */
|
1613
2186
|
transactionRequestId: components["schemas"]["CorrelationId"];
|
1614
2187
|
/** @description Information about the Payee in the proposed financial transaction. */
|
1615
2188
|
payee: components["schemas"]["Party"];
|
@@ -1634,8 +2207,8 @@ export interface components {
|
|
1634
2207
|
/**
|
1635
2208
|
* ThirdpartyRequestsTransactionsIDPutResponse
|
1636
2209
|
* @description Used by: DFSP
|
1637
|
-
*
|
1638
|
-
*
|
2210
|
+
* After a PISP requests the creation of a Third Party Transaction request (POST /thirdpartyRequests/transactions) or the status of a previously created Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}), the DFSP will send this callback.
|
2211
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
1639
2212
|
*/
|
1640
2213
|
ThirdpartyRequestsTransactionsIDPutResponse: {
|
1641
2214
|
transactionId?: components["schemas"]["CorrelationId"];
|
@@ -1645,10 +2218,10 @@ export interface components {
|
|
1645
2218
|
/**
|
1646
2219
|
* ThirdpartyRequestsAuthorizationsPostRequest
|
1647
2220
|
* @description Used by: DFSP
|
1648
|
-
*
|
1649
|
-
*
|
1650
|
-
*
|
1651
|
-
*
|
2221
|
+
* The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request.
|
2222
|
+
* Callback and data model information for POST /thirdpartyRequests/authorizations:
|
2223
|
+
* Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url
|
2224
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
1652
2225
|
*/
|
1653
2226
|
ThirdpartyRequestsAuthorizationsPostRequest: {
|
1654
2227
|
authorizationRequestId: components["schemas"]["CorrelationId"];
|
@@ -1701,34 +2274,38 @@ export interface components {
|
|
1701
2274
|
/**
|
1702
2275
|
* FIDOPublicKeyCredentialAssertion
|
1703
2276
|
* @description A data model representing a FIDO Assertion result.
|
1704
|
-
*
|
2277
|
+
* Derived from PublicKeyCredential Interface in WebAuthN.
|
1705
2278
|
*
|
1706
|
-
*
|
1707
|
-
*
|
1708
|
-
*
|
2279
|
+
* The PublicKeyCredential interface represents the below fields with a Type of
|
2280
|
+
* Javascript ArrayBuffer.
|
2281
|
+
* For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
2282
|
+
*
|
2283
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
1709
2284
|
*
|
1710
|
-
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
1711
2285
|
*/
|
1712
2286
|
FIDOPublicKeyCredentialAssertion: {
|
1713
|
-
/**
|
1714
|
-
*
|
1715
|
-
*
|
1716
|
-
*/
|
2287
|
+
/** @description credential id: identifier of pair of keys, base64 encoded
|
2288
|
+
* https://w3c.github.io/webauthn/#ref-for-dom-credential-id
|
2289
|
+
* */
|
1717
2290
|
id: string;
|
1718
|
-
/** @description raw credential id: identifier of pair of keys, base64 encoded.
|
2291
|
+
/** @description raw credential id: identifier of pair of keys, base64 encoded.
|
2292
|
+
* */
|
1719
2293
|
rawId: string;
|
1720
|
-
/** @description AuthenticatorAssertionResponse
|
2294
|
+
/** @description AuthenticatorAssertionResponse
|
2295
|
+
* */
|
1721
2296
|
response: {
|
1722
|
-
/** @description Authenticator data object.
|
2297
|
+
/** @description Authenticator data object.
|
2298
|
+
* */
|
1723
2299
|
authenticatorData: string;
|
1724
|
-
/** @description JSON string with client data.
|
2300
|
+
/** @description JSON string with client data.
|
2301
|
+
* */
|
1725
2302
|
clientDataJSON: string;
|
1726
|
-
/** @description The signature generated by the private key associated with this credential.
|
2303
|
+
/** @description The signature generated by the private key associated with this credential.
|
2304
|
+
* */
|
1727
2305
|
signature: string;
|
1728
|
-
/**
|
1729
|
-
*
|
1730
|
-
*
|
1731
|
-
*/
|
2306
|
+
/** @description This field is optionally provided by the authenticator, and
|
2307
|
+
* represents the user.id that was supplied during registration.
|
2308
|
+
* */
|
1732
2309
|
userHandle?: string;
|
1733
2310
|
};
|
1734
2311
|
/**
|
@@ -1779,10 +2356,9 @@ export interface components {
|
|
1779
2356
|
verificationRequestId: components["schemas"]["CorrelationId"];
|
1780
2357
|
/** @description Base64 encoded bytes - The challenge generated by the DFSP. */
|
1781
2358
|
challenge: string;
|
1782
|
-
/**
|
1783
|
-
*
|
1784
|
-
*
|
1785
|
-
*/
|
2359
|
+
/** @description The id of the stored consent object that contains the credential with which to verify
|
2360
|
+
* the signed challenge against.
|
2361
|
+
* */
|
1786
2362
|
consentId: components["schemas"]["CorrelationId"];
|
1787
2363
|
signedPayloadType: components["schemas"]["SignedPayloadTypeFIDO"];
|
1788
2364
|
fidoSignedPayload: components["schemas"]["FIDOPublicKeyCredentialAssertion"];
|
@@ -1796,10 +2372,9 @@ export interface components {
|
|
1796
2372
|
verificationRequestId: components["schemas"]["CorrelationId"];
|
1797
2373
|
/** @description Base64 encoded bytes - The challenge generated by the DFSP. */
|
1798
2374
|
challenge: string;
|
1799
|
-
/**
|
1800
|
-
*
|
1801
|
-
*
|
1802
|
-
*/
|
2375
|
+
/** @description The id of the stored consent object that contains the credential with which to verify
|
2376
|
+
* the signed challenge against.
|
2377
|
+
* */
|
1803
2378
|
consentId: components["schemas"]["CorrelationId"];
|
1804
2379
|
signedPayloadType: components["schemas"]["SignedPayloadTypeGeneric"];
|
1805
2380
|
genericSignedPayload: components["schemas"]["BinaryString"];
|
@@ -1808,15 +2383,15 @@ export interface components {
|
|
1808
2383
|
/**
|
1809
2384
|
* AuthenticationResponse
|
1810
2385
|
* @description The AuthenticationResponse enumeration describes the result of authenticating verification request.
|
1811
|
-
*
|
2386
|
+
* Below are the allowed values for the enumeration AuthenticationResponse. - VERIFIED - The challenge was correctly signed.
|
1812
2387
|
* @enum {string}
|
1813
2388
|
*/
|
1814
2389
|
AuthenticationResponse: "VERIFIED";
|
1815
2390
|
/**
|
1816
2391
|
* ThirdpartyRequestsVerificationsIDPutResponse
|
1817
2392
|
* @description Used by: Auth Service
|
1818
|
-
*
|
1819
|
-
*
|
2393
|
+
* The callback PUT /thirdpartyRequests/verifications/{ID} is used to inform the client of the result of an authorization check. The {ID} in the URI should contain the authorizationRequestId which was used to request the check, or the {ID} that was used in the GET /thirdpartyRequests/verifications/{ID}.
|
2394
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
|
1820
2395
|
*/
|
1821
2396
|
ThirdpartyRequestsVerificationsIDPutResponse: {
|
1822
2397
|
authenticationResponse: components["schemas"]["AuthenticationResponse"];
|
@@ -1826,17 +2401,24 @@ export interface components {
|
|
1826
2401
|
responses: {
|
1827
2402
|
/** @description OK */
|
1828
2403
|
200: {
|
1829
|
-
|
2404
|
+
headers: {
|
2405
|
+
[name: string]: unknown;
|
2406
|
+
};
|
2407
|
+
content?: never;
|
1830
2408
|
};
|
1831
2409
|
/** @description Accepted */
|
1832
2410
|
202: {
|
1833
|
-
|
2411
|
+
headers: {
|
2412
|
+
[name: string]: unknown;
|
2413
|
+
};
|
2414
|
+
content?: never;
|
1834
2415
|
};
|
1835
2416
|
/** @description Bad Request */
|
1836
2417
|
400: {
|
1837
2418
|
headers: {
|
1838
2419
|
"Content-Length": components["headers"]["Content-Length"];
|
1839
2420
|
"Content-Type": components["headers"]["Content-Type"];
|
2421
|
+
[name: string]: unknown;
|
1840
2422
|
};
|
1841
2423
|
content: {
|
1842
2424
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1847,6 +2429,7 @@ export interface components {
|
|
1847
2429
|
headers: {
|
1848
2430
|
"Content-Length": components["headers"]["Content-Length"];
|
1849
2431
|
"Content-Type": components["headers"]["Content-Type"];
|
2432
|
+
[name: string]: unknown;
|
1850
2433
|
};
|
1851
2434
|
content: {
|
1852
2435
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1857,6 +2440,7 @@ export interface components {
|
|
1857
2440
|
headers: {
|
1858
2441
|
"Content-Length": components["headers"]["Content-Length"];
|
1859
2442
|
"Content-Type": components["headers"]["Content-Type"];
|
2443
|
+
[name: string]: unknown;
|
1860
2444
|
};
|
1861
2445
|
content: {
|
1862
2446
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1867,6 +2451,7 @@ export interface components {
|
|
1867
2451
|
headers: {
|
1868
2452
|
"Content-Length": components["headers"]["Content-Length"];
|
1869
2453
|
"Content-Type": components["headers"]["Content-Type"];
|
2454
|
+
[name: string]: unknown;
|
1870
2455
|
};
|
1871
2456
|
content: {
|
1872
2457
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1877,6 +2462,7 @@ export interface components {
|
|
1877
2462
|
headers: {
|
1878
2463
|
"Content-Length": components["headers"]["Content-Length"];
|
1879
2464
|
"Content-Type": components["headers"]["Content-Type"];
|
2465
|
+
[name: string]: unknown;
|
1880
2466
|
};
|
1881
2467
|
content: {
|
1882
2468
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1887,6 +2473,7 @@ export interface components {
|
|
1887
2473
|
headers: {
|
1888
2474
|
"Content-Length": components["headers"]["Content-Length"];
|
1889
2475
|
"Content-Type": components["headers"]["Content-Type"];
|
2476
|
+
[name: string]: unknown;
|
1890
2477
|
};
|
1891
2478
|
content: {
|
1892
2479
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1897,6 +2484,7 @@ export interface components {
|
|
1897
2484
|
headers: {
|
1898
2485
|
"Content-Length": components["headers"]["Content-Length"];
|
1899
2486
|
"Content-Type": components["headers"]["Content-Type"];
|
2487
|
+
[name: string]: unknown;
|
1900
2488
|
};
|
1901
2489
|
content: {
|
1902
2490
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1907,6 +2495,7 @@ export interface components {
|
|
1907
2495
|
headers: {
|
1908
2496
|
"Content-Length": components["headers"]["Content-Length"];
|
1909
2497
|
"Content-Type": components["headers"]["Content-Type"];
|
2498
|
+
[name: string]: unknown;
|
1910
2499
|
};
|
1911
2500
|
content: {
|
1912
2501
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1920,32 +2509,28 @@ export interface components {
|
|
1920
2509
|
"Content-Type": string;
|
1921
2510
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
1922
2511
|
Date: string;
|
1923
|
-
/**
|
1924
|
-
* @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2512
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
1925
2513
|
*
|
1926
|
-
*
|
1927
|
-
|
1928
|
-
"X-Forwarded-For"?: string;
|
2514
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2515
|
+
"X-Forwarded-For": string;
|
1929
2516
|
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
1930
2517
|
"FSPIOP-Source": string;
|
1931
2518
|
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1932
|
-
"FSPIOP-Destination"
|
2519
|
+
"FSPIOP-Destination": string;
|
1933
2520
|
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1934
|
-
"FSPIOP-Encryption"
|
2521
|
+
"FSPIOP-Encryption": string;
|
1935
2522
|
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1936
|
-
"FSPIOP-Signature"
|
2523
|
+
"FSPIOP-Signature": string;
|
1937
2524
|
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
1938
|
-
"FSPIOP-URI"
|
2525
|
+
"FSPIOP-URI": string;
|
1939
2526
|
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
1940
|
-
"FSPIOP-HTTP-Method"
|
2527
|
+
"FSPIOP-HTTP-Method": string;
|
1941
2528
|
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1942
2529
|
Accept: string;
|
1943
|
-
/**
|
1944
|
-
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2530
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1945
2531
|
*
|
1946
|
-
*
|
1947
|
-
|
1948
|
-
"Content-Length"?: number;
|
2532
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2533
|
+
"Content-Length": number;
|
1949
2534
|
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1950
2535
|
Type: string;
|
1951
2536
|
/** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
@@ -1953,11 +2538,9 @@ export interface components {
|
|
1953
2538
|
};
|
1954
2539
|
requestBodies: never;
|
1955
2540
|
headers: {
|
1956
|
-
/**
|
1957
|
-
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2541
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1958
2542
|
*
|
1959
|
-
*
|
1960
|
-
*/
|
2543
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1961
2544
|
"Content-Length": number;
|
1962
2545
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1963
2546
|
"Content-Type": string;
|
@@ -1965,10 +2548,14 @@ export interface components {
|
|
1965
2548
|
pathItems: never;
|
1966
2549
|
}
|
1967
2550
|
export type $defs = Record<string, never>;
|
1968
|
-
export type external = Record<string, never>;
|
1969
2551
|
export interface operations {
|
1970
|
-
/** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
1971
2552
|
test: {
|
2553
|
+
parameters: {
|
2554
|
+
query?: never;
|
2555
|
+
header?: never;
|
2556
|
+
path?: never;
|
2557
|
+
cookie?: never;
|
2558
|
+
};
|
1972
2559
|
requestBody?: {
|
1973
2560
|
content: {
|
1974
2561
|
"application/json": components["schemas"]["ParticipantsIDPutResponse"] | components["schemas"]["PartiesTypeIDPutResponse"] | components["schemas"]["QuotesIDPutResponse"] | components["schemas"]["ThirdpartyRequestsTransactionsIDPatchResponse"] | components["schemas"]["AuthorizationResponseType"] | components["schemas"]["ConsentStatusIssued"] | components["schemas"]["IlpFulfilment"] | components["schemas"]["Integer"] | components["schemas"]["Note"] | components["schemas"]["PartyIdInfoTPLink"] | components["schemas"]["PartyResult"] | components["schemas"]["ServiceType"] | components["schemas"]["ParticipantsPostRequest"] | components["schemas"]["QuotesPostRequest"];
|
@@ -1977,32 +2564,47 @@ export interface operations {
|
|
1977
2564
|
responses: {
|
1978
2565
|
/** @description Ok */
|
1979
2566
|
200: {
|
1980
|
-
|
2567
|
+
headers: {
|
2568
|
+
[name: string]: unknown;
|
2569
|
+
};
|
2570
|
+
content?: never;
|
1981
2571
|
};
|
1982
2572
|
};
|
1983
2573
|
};
|
1984
|
-
/**
|
1985
|
-
* GetAccountsByUserId
|
1986
|
-
* @description The HTTP request `GET /accounts/{ID}` is used to retrieve the list of potential accounts available for linking.
|
1987
|
-
*/
|
1988
2574
|
GetAccountsByUserId: {
|
1989
2575
|
parameters: {
|
2576
|
+
query?: never;
|
1990
2577
|
header: {
|
2578
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1991
2579
|
"Content-Type": components["parameters"]["Content-Type"];
|
2580
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1992
2581
|
Date: components["parameters"]["Date"];
|
2582
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2583
|
+
*
|
2584
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
1993
2585
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2586
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
1994
2587
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2588
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1995
2589
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2590
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1996
2591
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2592
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1997
2593
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2594
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
1998
2595
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2596
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
1999
2597
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2598
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2000
2599
|
Accept: components["parameters"]["Accept"];
|
2001
2600
|
};
|
2002
2601
|
path: {
|
2602
|
+
/** @description The identifier value. */
|
2003
2603
|
ID: components["parameters"]["ID"];
|
2004
2604
|
};
|
2605
|
+
cookie?: never;
|
2005
2606
|
};
|
2607
|
+
requestBody?: never;
|
2006
2608
|
responses: {
|
2007
2609
|
202: components["responses"]["202"];
|
2008
2610
|
400: components["responses"]["400"];
|
@@ -2015,44 +2617,55 @@ export interface operations {
|
|
2015
2617
|
503: components["responses"]["503"];
|
2016
2618
|
};
|
2017
2619
|
};
|
2018
|
-
/**
|
2019
|
-
* UpdateAccountsByUserId
|
2020
|
-
* @description The HTTP request `PUT /accounts/{ID}` is used to return the list of potential accounts available for linking
|
2021
|
-
*/
|
2022
2620
|
UpdateAccountsByUserId: {
|
2023
2621
|
parameters: {
|
2622
|
+
query?: never;
|
2024
2623
|
header: {
|
2624
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2025
2625
|
"Content-Type": components["parameters"]["Content-Type"];
|
2626
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2026
2627
|
Date: components["parameters"]["Date"];
|
2628
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2629
|
+
*
|
2630
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2027
2631
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2632
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2028
2633
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2634
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2029
2635
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2636
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2030
2637
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2638
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2031
2639
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2640
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2032
2641
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2642
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2033
2643
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2644
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2645
|
+
*
|
2646
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2034
2647
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2035
2648
|
};
|
2036
2649
|
path: {
|
2650
|
+
/** @description The identifier value. */
|
2037
2651
|
ID: components["parameters"]["ID"];
|
2038
2652
|
};
|
2653
|
+
cookie?: never;
|
2039
2654
|
};
|
2040
2655
|
requestBody: {
|
2041
2656
|
content: {
|
2042
|
-
/**
|
2043
|
-
*
|
2044
|
-
*
|
2045
|
-
*
|
2046
|
-
*
|
2047
|
-
*
|
2048
|
-
*
|
2049
|
-
*
|
2050
|
-
*
|
2051
|
-
*
|
2052
|
-
*
|
2053
|
-
*
|
2054
|
-
* ]
|
2055
|
-
*/
|
2657
|
+
/** @example [
|
2658
|
+
* {
|
2659
|
+
* "accountNickname": "dfspa.user.nickname1",
|
2660
|
+
* "id": "dfspa.username.1234",
|
2661
|
+
* "currency": "ZAR"
|
2662
|
+
* },
|
2663
|
+
* {
|
2664
|
+
* "accountNickname": "dfspa.user.nickname2",
|
2665
|
+
* "id": "dfspa.username.5678",
|
2666
|
+
* "currency": "USD"
|
2667
|
+
* }
|
2668
|
+
* ] */
|
2056
2669
|
"application/json": components["schemas"]["AccountsIDPutResponse"];
|
2057
2670
|
};
|
2058
2671
|
};
|
@@ -2068,27 +2681,40 @@ export interface operations {
|
|
2068
2681
|
503: components["responses"]["503"];
|
2069
2682
|
};
|
2070
2683
|
};
|
2071
|
-
/**
|
2072
|
-
* UpdateAccountsByUserIdError
|
2073
|
-
* @description The HTTP request `PUT /accounts/{ID}/error` is used to return error information
|
2074
|
-
*/
|
2075
2684
|
UpdateAccountsByUserIdError: {
|
2076
2685
|
parameters: {
|
2686
|
+
query?: never;
|
2077
2687
|
header: {
|
2688
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2078
2689
|
"Content-Type": components["parameters"]["Content-Type"];
|
2690
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2079
2691
|
Date: components["parameters"]["Date"];
|
2692
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2693
|
+
*
|
2694
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2080
2695
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2696
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2081
2697
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2698
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2082
2699
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2700
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2083
2701
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2702
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2084
2703
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2704
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2085
2705
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2706
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2086
2707
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2708
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2709
|
+
*
|
2710
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2087
2711
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2088
2712
|
};
|
2089
2713
|
path: {
|
2714
|
+
/** @description The identifier value. */
|
2090
2715
|
ID: components["parameters"]["ID"];
|
2091
2716
|
};
|
2717
|
+
cookie?: never;
|
2092
2718
|
};
|
2093
2719
|
/** @description Details of the error returned. */
|
2094
2720
|
requestBody: {
|
@@ -2108,11 +2734,14 @@ export interface operations {
|
|
2108
2734
|
503: components["responses"]["503"];
|
2109
2735
|
};
|
2110
2736
|
};
|
2111
|
-
/**
|
2112
|
-
* Health check endpoint
|
2113
|
-
* @description The HTTP request GET /health is used to return the current status of the API.
|
2114
|
-
*/
|
2115
2737
|
HealthGet: {
|
2738
|
+
parameters: {
|
2739
|
+
query?: never;
|
2740
|
+
header?: never;
|
2741
|
+
path?: never;
|
2742
|
+
cookie?: never;
|
2743
|
+
};
|
2744
|
+
requestBody?: never;
|
2116
2745
|
responses: {
|
2117
2746
|
200: components["responses"]["200"];
|
2118
2747
|
400: components["responses"]["400"];
|
@@ -2125,11 +2754,14 @@ export interface operations {
|
|
2125
2754
|
503: components["responses"]["503"];
|
2126
2755
|
};
|
2127
2756
|
};
|
2128
|
-
/**
|
2129
|
-
* Prometheus metrics endpoint
|
2130
|
-
* @description The HTTP request GET /metrics is used to return metrics for the API.
|
2131
|
-
*/
|
2132
2757
|
MetricsGet: {
|
2758
|
+
parameters: {
|
2759
|
+
query?: never;
|
2760
|
+
header?: never;
|
2761
|
+
path?: never;
|
2762
|
+
cookie?: never;
|
2763
|
+
};
|
2764
|
+
requestBody?: never;
|
2133
2765
|
responses: {
|
2134
2766
|
200: components["responses"]["200"];
|
2135
2767
|
400: components["responses"]["400"];
|
@@ -2142,26 +2774,39 @@ export interface operations {
|
|
2142
2774
|
503: components["responses"]["503"];
|
2143
2775
|
};
|
2144
2776
|
};
|
2145
|
-
/**
|
2146
|
-
* CreateConsentRequest
|
2147
|
-
* @description The HTTP request **POST /consentRequests** is used to request a DFSP to grant access to one or more
|
2148
|
-
* accounts owned by a customer of the DFSP for the PISP who sends the request.
|
2149
|
-
*/
|
2150
2777
|
CreateConsentRequest: {
|
2151
2778
|
parameters: {
|
2779
|
+
query?: never;
|
2152
2780
|
header: {
|
2781
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2153
2782
|
"Content-Type": components["parameters"]["Content-Type"];
|
2783
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2154
2784
|
Date: components["parameters"]["Date"];
|
2785
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2786
|
+
*
|
2787
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2155
2788
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2789
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2156
2790
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2791
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2157
2792
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2793
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2158
2794
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2795
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2159
2796
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2797
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2160
2798
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2799
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2161
2800
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2801
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2162
2802
|
Accept: components["parameters"]["Accept"];
|
2803
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2804
|
+
*
|
2805
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2163
2806
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2164
2807
|
};
|
2808
|
+
path?: never;
|
2809
|
+
cookie?: never;
|
2165
2810
|
};
|
2166
2811
|
/** @description The consentRequest to create */
|
2167
2812
|
requestBody: {
|
@@ -2181,30 +2826,40 @@ export interface operations {
|
|
2181
2826
|
503: components["responses"]["503"];
|
2182
2827
|
};
|
2183
2828
|
};
|
2184
|
-
/**
|
2185
|
-
* GetConsentRequestsById
|
2186
|
-
* @description The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously
|
2187
|
-
* requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the
|
2188
|
-
* request by the PISP when the PISP originated the request.
|
2189
|
-
*/
|
2190
2829
|
GetConsentRequestsById: {
|
2191
2830
|
parameters: {
|
2831
|
+
query?: never;
|
2192
2832
|
header: {
|
2833
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2193
2834
|
"Content-Type": components["parameters"]["Content-Type"];
|
2835
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2194
2836
|
Date: components["parameters"]["Date"];
|
2837
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2838
|
+
*
|
2839
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2195
2840
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2841
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2196
2842
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2843
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2197
2844
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2845
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2198
2846
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2847
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2199
2848
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2849
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2200
2850
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2851
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2201
2852
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2853
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2202
2854
|
Accept: components["parameters"]["Accept"];
|
2203
2855
|
};
|
2204
2856
|
path: {
|
2857
|
+
/** @description The identifier value. */
|
2205
2858
|
ID: components["parameters"]["ID"];
|
2206
2859
|
};
|
2860
|
+
cookie?: never;
|
2207
2861
|
};
|
2862
|
+
requestBody?: never;
|
2208
2863
|
responses: {
|
2209
2864
|
202: components["responses"]["202"];
|
2210
2865
|
400: components["responses"]["400"];
|
@@ -2217,35 +2872,40 @@ export interface operations {
|
|
2217
2872
|
503: components["responses"]["503"];
|
2218
2873
|
};
|
2219
2874
|
};
|
2220
|
-
/**
|
2221
|
-
* UpdateConsentRequest
|
2222
|
-
* @description A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted,
|
2223
|
-
* and (2) communicate to the PISP which `authChannel` it should use to authenticate their user
|
2224
|
-
* with.
|
2225
|
-
*
|
2226
|
-
* When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all
|
2227
|
-
* the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization
|
2228
|
-
* process may result in additional privileges being granted by the account holder to the PISP. The
|
2229
|
-
* **PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a
|
2230
|
-
* particular authorization request.
|
2231
|
-
*/
|
2232
2875
|
UpdateConsentRequest: {
|
2233
2876
|
parameters: {
|
2877
|
+
query?: never;
|
2234
2878
|
header: {
|
2879
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2235
2880
|
"Content-Type": components["parameters"]["Content-Type"];
|
2881
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2236
2882
|
Date: components["parameters"]["Date"];
|
2883
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2884
|
+
*
|
2885
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2237
2886
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2887
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2238
2888
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2889
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2239
2890
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2891
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2240
2892
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2893
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2241
2894
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2895
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2242
2896
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2897
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2243
2898
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2899
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2900
|
+
*
|
2901
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2244
2902
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2245
2903
|
};
|
2246
2904
|
path: {
|
2905
|
+
/** @description The identifier value. */
|
2247
2906
|
ID: components["parameters"]["ID"];
|
2248
2907
|
};
|
2908
|
+
cookie?: never;
|
2249
2909
|
};
|
2250
2910
|
requestBody: {
|
2251
2911
|
content: {
|
@@ -2264,28 +2924,42 @@ export interface operations {
|
|
2264
2924
|
503: components["responses"]["503"];
|
2265
2925
|
};
|
2266
2926
|
};
|
2267
|
-
/**
|
2268
|
-
* PatchConsentRequest
|
2269
|
-
* @description After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
|
2270
|
-
*/
|
2271
2927
|
PatchConsentRequest: {
|
2272
2928
|
parameters: {
|
2929
|
+
query?: never;
|
2273
2930
|
header: {
|
2931
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2274
2932
|
"Content-Type": components["parameters"]["Content-Type"];
|
2933
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2275
2934
|
Date: components["parameters"]["Date"];
|
2935
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2936
|
+
*
|
2937
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2276
2938
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2939
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2277
2940
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2941
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2278
2942
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2943
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2279
2944
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2945
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2280
2946
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2947
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2281
2948
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2949
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2282
2950
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2951
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2283
2952
|
Accept: components["parameters"]["Accept"];
|
2953
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2954
|
+
*
|
2955
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2284
2956
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2285
2957
|
};
|
2286
2958
|
path: {
|
2959
|
+
/** @description The identifier value. */
|
2287
2960
|
ID: components["parameters"]["ID"];
|
2288
2961
|
};
|
2962
|
+
cookie?: never;
|
2289
2963
|
};
|
2290
2964
|
requestBody: {
|
2291
2965
|
content: {
|
@@ -2304,27 +2978,40 @@ export interface operations {
|
|
2304
2978
|
503: components["responses"]["503"];
|
2305
2979
|
};
|
2306
2980
|
};
|
2307
|
-
/**
|
2308
|
-
* NotifyErrorConsentRequests
|
2309
|
-
* @description DFSP responds to the PISP if something went wrong with validating an OTP or secret.
|
2310
|
-
*/
|
2311
2981
|
NotifyErrorConsentRequests: {
|
2312
2982
|
parameters: {
|
2983
|
+
query?: never;
|
2313
2984
|
header: {
|
2985
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2314
2986
|
"Content-Type": components["parameters"]["Content-Type"];
|
2987
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2315
2988
|
Date: components["parameters"]["Date"];
|
2989
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
2990
|
+
*
|
2991
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2316
2992
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2993
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2317
2994
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2995
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2318
2996
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2997
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2319
2998
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2999
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2320
3000
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3001
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2321
3002
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3003
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2322
3004
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3005
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3006
|
+
*
|
3007
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2323
3008
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2324
3009
|
};
|
2325
3010
|
path: {
|
3011
|
+
/** @description The identifier value. */
|
2326
3012
|
ID: components["parameters"]["ID"];
|
2327
3013
|
};
|
3014
|
+
cookie?: never;
|
2328
3015
|
};
|
2329
3016
|
/** @description Error information returned. */
|
2330
3017
|
requestBody: {
|
@@ -2344,25 +3031,39 @@ export interface operations {
|
|
2344
3031
|
503: components["responses"]["503"];
|
2345
3032
|
};
|
2346
3033
|
};
|
2347
|
-
/**
|
2348
|
-
* PostConsents
|
2349
|
-
* @description The **POST /consents** request is used to request the creation of a consent for interactions between a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to.
|
2350
|
-
*/
|
2351
3034
|
PostConsents: {
|
2352
3035
|
parameters: {
|
3036
|
+
query?: never;
|
2353
3037
|
header: {
|
3038
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2354
3039
|
"Content-Type": components["parameters"]["Content-Type"];
|
3040
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2355
3041
|
Date: components["parameters"]["Date"];
|
3042
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3043
|
+
*
|
3044
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2356
3045
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3046
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2357
3047
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3048
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2358
3049
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3050
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2359
3051
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3052
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2360
3053
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3054
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2361
3055
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3056
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2362
3057
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3058
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2363
3059
|
Accept: components["parameters"]["Accept"];
|
3060
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3061
|
+
*
|
3062
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2364
3063
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2365
3064
|
};
|
3065
|
+
path?: never;
|
3066
|
+
cookie?: never;
|
2366
3067
|
};
|
2367
3068
|
requestBody: {
|
2368
3069
|
content: {
|
@@ -2381,28 +3082,40 @@ export interface operations {
|
|
2381
3082
|
503: components["responses"]["503"];
|
2382
3083
|
};
|
2383
3084
|
};
|
2384
|
-
/**
|
2385
|
-
* GetConsent
|
2386
|
-
* @description The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created.
|
2387
|
-
*/
|
2388
3085
|
GetConsent: {
|
2389
3086
|
parameters: {
|
3087
|
+
query?: never;
|
2390
3088
|
header: {
|
3089
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2391
3090
|
"Content-Type": components["parameters"]["Content-Type"];
|
3091
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2392
3092
|
Date: components["parameters"]["Date"];
|
3093
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3094
|
+
*
|
3095
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2393
3096
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3097
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2394
3098
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3099
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2395
3100
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3101
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2396
3102
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3103
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2397
3104
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3105
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2398
3106
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3107
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2399
3108
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3109
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2400
3110
|
Accept: components["parameters"]["Accept"];
|
2401
3111
|
};
|
2402
3112
|
path: {
|
3113
|
+
/** @description The identifier value. */
|
2403
3114
|
ID: components["parameters"]["ID"];
|
2404
3115
|
};
|
3116
|
+
cookie?: never;
|
2405
3117
|
};
|
3118
|
+
requestBody?: never;
|
2406
3119
|
responses: {
|
2407
3120
|
202: components["responses"]["202"];
|
2408
3121
|
400: components["responses"]["400"];
|
@@ -2415,30 +3128,40 @@ export interface operations {
|
|
2415
3128
|
503: components["responses"]["503"];
|
2416
3129
|
};
|
2417
3130
|
};
|
2418
|
-
/**
|
2419
|
-
* PutConsentByID
|
2420
|
-
* @description The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth Service.
|
2421
|
-
*
|
2422
|
-
* - Called by a `PISP` to after signing a challenge. Sent to an DFSP for verification.
|
2423
|
-
* - Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
|
2424
|
-
*/
|
2425
3131
|
PutConsentByID: {
|
2426
3132
|
parameters: {
|
3133
|
+
query?: never;
|
2427
3134
|
header: {
|
3135
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2428
3136
|
"Content-Type": components["parameters"]["Content-Type"];
|
3137
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2429
3138
|
Date: components["parameters"]["Date"];
|
3139
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3140
|
+
*
|
3141
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2430
3142
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3143
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2431
3144
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3145
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2432
3146
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3147
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2433
3148
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3149
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2434
3150
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3151
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2435
3152
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3153
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2436
3154
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3155
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3156
|
+
*
|
3157
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2437
3158
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2438
3159
|
};
|
2439
3160
|
path: {
|
3161
|
+
/** @description The identifier value. */
|
2440
3162
|
ID: components["parameters"]["ID"];
|
2441
3163
|
};
|
3164
|
+
cookie?: never;
|
2442
3165
|
};
|
2443
3166
|
requestBody: {
|
2444
3167
|
content: {
|
@@ -2458,32 +3181,40 @@ export interface operations {
|
|
2458
3181
|
503: components["responses"]["503"];
|
2459
3182
|
};
|
2460
3183
|
};
|
2461
|
-
/**
|
2462
|
-
* @description Used by PISP, DFSP
|
2463
|
-
*
|
2464
|
-
* The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent.
|
2465
|
-
* For tracing and auditing purposes, the switch should be sure not to delete the consent physically;
|
2466
|
-
* instead, information relating to the consent should be marked as deleted and requests relating to the
|
2467
|
-
* consent should not be honoured.
|
2468
|
-
*/
|
2469
3184
|
DeleteConsentByID: {
|
2470
3185
|
parameters: {
|
3186
|
+
query?: never;
|
2471
3187
|
header: {
|
3188
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2472
3189
|
"Content-Type": components["parameters"]["Content-Type"];
|
3190
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2473
3191
|
Date: components["parameters"]["Date"];
|
3192
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3193
|
+
*
|
3194
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2474
3195
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3196
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2475
3197
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3198
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2476
3199
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3200
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2477
3201
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3202
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2478
3203
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3204
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2479
3205
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3206
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2480
3207
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3208
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2481
3209
|
Accept: components["parameters"]["Accept"];
|
2482
3210
|
};
|
2483
3211
|
path: {
|
3212
|
+
/** @description The identifier value. */
|
2484
3213
|
ID: components["parameters"]["ID"];
|
2485
3214
|
};
|
3215
|
+
cookie?: never;
|
2486
3216
|
};
|
3217
|
+
requestBody?: never;
|
2487
3218
|
responses: {
|
2488
3219
|
202: components["responses"]["202"];
|
2489
3220
|
400: components["responses"]["400"];
|
@@ -2496,38 +3227,42 @@ export interface operations {
|
|
2496
3227
|
503: components["responses"]["503"];
|
2497
3228
|
};
|
2498
3229
|
};
|
2499
|
-
/**
|
2500
|
-
* PatchConsentByID
|
2501
|
-
* @description The HTTP request `PATCH /consents/{ID}` is used
|
2502
|
-
*
|
2503
|
-
* - In account linking in the Credential Registration phase. Used by a DFSP
|
2504
|
-
* to notify a PISP a credential has been verified and registered with an
|
2505
|
-
* Auth service.
|
2506
|
-
*
|
2507
|
-
* - In account unlinking by a hub hosted auth service and by DFSPs
|
2508
|
-
* in non-hub hosted scenarios to notify participants of a consent being revoked.
|
2509
|
-
*
|
2510
|
-
* Called by a `auth-service` to notify a PISP and DFSP of consent status in hub hosted scenario.
|
2511
|
-
* Called by a `DFSP` to notify a PISP of consent status in non-hub hosted scenario.
|
2512
|
-
*/
|
2513
3230
|
PatchConsentByID: {
|
2514
3231
|
parameters: {
|
3232
|
+
query?: never;
|
2515
3233
|
header: {
|
3234
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2516
3235
|
"Content-Type": components["parameters"]["Content-Type"];
|
3236
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2517
3237
|
Date: components["parameters"]["Date"];
|
3238
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3239
|
+
*
|
3240
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2518
3241
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3242
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2519
3243
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3244
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2520
3245
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3246
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2521
3247
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3248
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2522
3249
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3250
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2523
3251
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3252
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2524
3253
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3254
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2525
3255
|
Accept: components["parameters"]["Accept"];
|
3256
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3257
|
+
*
|
3258
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2526
3259
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2527
3260
|
};
|
2528
3261
|
path: {
|
3262
|
+
/** @description The identifier value. */
|
2529
3263
|
ID: components["parameters"]["ID"];
|
2530
3264
|
};
|
3265
|
+
cookie?: never;
|
2531
3266
|
};
|
2532
3267
|
requestBody: {
|
2533
3268
|
content: {
|
@@ -2546,27 +3281,40 @@ export interface operations {
|
|
2546
3281
|
503: components["responses"]["503"];
|
2547
3282
|
};
|
2548
3283
|
};
|
2549
|
-
/**
|
2550
|
-
* NotifyErrorConsents
|
2551
|
-
* @description DFSP responds to the PISP if something went wrong with validating or storing consent.
|
2552
|
-
*/
|
2553
3284
|
NotifyErrorConsents: {
|
2554
3285
|
parameters: {
|
3286
|
+
query?: never;
|
2555
3287
|
header: {
|
3288
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2556
3289
|
"Content-Type": components["parameters"]["Content-Type"];
|
3290
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2557
3291
|
Date: components["parameters"]["Date"];
|
3292
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3293
|
+
*
|
3294
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2558
3295
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3296
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2559
3297
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3298
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2560
3299
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3300
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2561
3301
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3302
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2562
3303
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3304
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2563
3305
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3306
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2564
3307
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3308
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3309
|
+
*
|
3310
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2565
3311
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2566
3312
|
};
|
2567
3313
|
path: {
|
3314
|
+
/** @description The identifier value. */
|
2568
3315
|
ID: components["parameters"]["ID"];
|
2569
3316
|
};
|
3317
|
+
cookie?: never;
|
2570
3318
|
};
|
2571
3319
|
/** @description Error information returned. */
|
2572
3320
|
requestBody: {
|
@@ -2586,25 +3334,39 @@ export interface operations {
|
|
2586
3334
|
503: components["responses"]["503"];
|
2587
3335
|
};
|
2588
3336
|
};
|
2589
|
-
/**
|
2590
|
-
* Create bulk participant information
|
2591
|
-
* @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.
|
2592
|
-
*/
|
2593
3337
|
Participants1: {
|
2594
3338
|
parameters: {
|
3339
|
+
query?: never;
|
2595
3340
|
header: {
|
3341
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2596
3342
|
"Content-Type": components["parameters"]["Content-Type"];
|
3343
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2597
3344
|
Date: components["parameters"]["Date"];
|
3345
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3346
|
+
*
|
3347
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2598
3348
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3349
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2599
3350
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3351
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2600
3352
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3353
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2601
3354
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3355
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2602
3356
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3357
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2603
3358
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3359
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2604
3360
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3361
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2605
3362
|
Accept: components["parameters"]["Accept"];
|
3363
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3364
|
+
*
|
3365
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2606
3366
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2607
3367
|
};
|
3368
|
+
path?: never;
|
3369
|
+
cookie?: never;
|
2608
3370
|
};
|
2609
3371
|
/** @description Participant information to be created. */
|
2610
3372
|
requestBody: {
|
@@ -2624,27 +3386,40 @@ export interface operations {
|
|
2624
3386
|
503: components["responses"]["503"];
|
2625
3387
|
};
|
2626
3388
|
};
|
2627
|
-
/**
|
2628
|
-
* Return bulk participant information
|
2629
|
-
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
2630
|
-
*/
|
2631
3389
|
PutParticipantsByID: {
|
2632
3390
|
parameters: {
|
3391
|
+
query?: never;
|
2633
3392
|
header: {
|
3393
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2634
3394
|
"Content-Type": components["parameters"]["Content-Type"];
|
3395
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2635
3396
|
Date: components["parameters"]["Date"];
|
3397
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3398
|
+
*
|
3399
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2636
3400
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3401
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2637
3402
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3403
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2638
3404
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3405
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2639
3406
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3407
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2640
3408
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3409
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2641
3410
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3411
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2642
3412
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3413
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3414
|
+
*
|
3415
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2643
3416
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2644
3417
|
};
|
2645
3418
|
path: {
|
3419
|
+
/** @description The identifier value. */
|
2646
3420
|
ID: components["parameters"]["ID"];
|
2647
3421
|
};
|
3422
|
+
cookie?: never;
|
2648
3423
|
};
|
2649
3424
|
/** @description Participant information returned. */
|
2650
3425
|
requestBody: {
|
@@ -2664,27 +3439,40 @@ export interface operations {
|
|
2664
3439
|
503: components["responses"]["503"];
|
2665
3440
|
};
|
2666
3441
|
};
|
2667
|
-
/**
|
2668
|
-
* Return bulk participant information error
|
2669
|
-
* @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information.
|
2670
|
-
*/
|
2671
3442
|
PutParticipantsByIDAndError: {
|
2672
3443
|
parameters: {
|
3444
|
+
query?: never;
|
2673
3445
|
header: {
|
3446
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2674
3447
|
"Content-Type": components["parameters"]["Content-Type"];
|
3448
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2675
3449
|
Date: components["parameters"]["Date"];
|
3450
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3451
|
+
*
|
3452
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2676
3453
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3454
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2677
3455
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3456
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2678
3457
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3458
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2679
3459
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3460
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2680
3461
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3462
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2681
3463
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3464
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2682
3465
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3466
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3467
|
+
*
|
3468
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2683
3469
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2684
3470
|
};
|
2685
3471
|
path: {
|
3472
|
+
/** @description The identifier value. */
|
2686
3473
|
ID: components["parameters"]["ID"];
|
2687
3474
|
};
|
3475
|
+
cookie?: never;
|
2688
3476
|
};
|
2689
3477
|
/** @description Details of the error returned. */
|
2690
3478
|
requestBody: {
|
@@ -2704,29 +3492,42 @@ export interface operations {
|
|
2704
3492
|
503: components["responses"]["503"];
|
2705
3493
|
};
|
2706
3494
|
};
|
2707
|
-
/**
|
2708
|
-
* Look up participant information
|
2709
|
-
* @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
2710
|
-
*/
|
2711
3495
|
ParticipantsByTypeAndID: {
|
2712
3496
|
parameters: {
|
3497
|
+
query?: never;
|
2713
3498
|
header: {
|
3499
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2714
3500
|
"Content-Type": components["parameters"]["Content-Type"];
|
3501
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2715
3502
|
Date: components["parameters"]["Date"];
|
3503
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3504
|
+
*
|
3505
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2716
3506
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3507
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2717
3508
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3509
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2718
3510
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3511
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2719
3512
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3513
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2720
3514
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3515
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2721
3516
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3517
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2722
3518
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3519
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2723
3520
|
Accept: components["parameters"]["Accept"];
|
2724
3521
|
};
|
2725
3522
|
path: {
|
3523
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2726
3524
|
Type: components["parameters"]["Type"];
|
3525
|
+
/** @description The identifier value. */
|
2727
3526
|
ID: components["parameters"]["ID"];
|
2728
3527
|
};
|
3528
|
+
cookie?: never;
|
2729
3529
|
};
|
3530
|
+
requestBody?: never;
|
2730
3531
|
responses: {
|
2731
3532
|
202: components["responses"]["202"];
|
2732
3533
|
400: components["responses"]["400"];
|
@@ -2739,28 +3540,42 @@ export interface operations {
|
|
2739
3540
|
503: components["responses"]["503"];
|
2740
3541
|
};
|
2741
3542
|
};
|
2742
|
-
/**
|
2743
|
-
* Return participant information
|
2744
|
-
* @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
|
2745
|
-
*/
|
2746
3543
|
ParticipantsByTypeAndID3: {
|
2747
3544
|
parameters: {
|
3545
|
+
query?: never;
|
2748
3546
|
header: {
|
3547
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2749
3548
|
"Content-Type": components["parameters"]["Content-Type"];
|
3549
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2750
3550
|
Date: components["parameters"]["Date"];
|
3551
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3552
|
+
*
|
3553
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2751
3554
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3555
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2752
3556
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3557
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2753
3558
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3559
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2754
3560
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3561
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2755
3562
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3563
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2756
3564
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3565
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2757
3566
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3567
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3568
|
+
*
|
3569
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2758
3570
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2759
3571
|
};
|
2760
3572
|
path: {
|
3573
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2761
3574
|
Type: components["parameters"]["Type"];
|
3575
|
+
/** @description The identifier value. */
|
2762
3576
|
ID: components["parameters"]["ID"];
|
2763
3577
|
};
|
3578
|
+
cookie?: never;
|
2764
3579
|
};
|
2765
3580
|
/** @description Participant information returned. */
|
2766
3581
|
requestBody: {
|
@@ -2780,29 +3595,44 @@ export interface operations {
|
|
2780
3595
|
503: components["responses"]["503"];
|
2781
3596
|
};
|
2782
3597
|
};
|
2783
|
-
/**
|
2784
|
-
* Create participant information
|
2785
|
-
* @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
2786
|
-
*/
|
2787
3598
|
ParticipantsByIDAndType: {
|
2788
3599
|
parameters: {
|
3600
|
+
query?: never;
|
2789
3601
|
header: {
|
3602
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2790
3603
|
"Content-Type": components["parameters"]["Content-Type"];
|
3604
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2791
3605
|
Date: components["parameters"]["Date"];
|
3606
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3607
|
+
*
|
3608
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2792
3609
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3610
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2793
3611
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3612
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2794
3613
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3614
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2795
3615
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3616
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2796
3617
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3618
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2797
3619
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3620
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2798
3621
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3622
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2799
3623
|
Accept: components["parameters"]["Accept"];
|
3624
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3625
|
+
*
|
3626
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2800
3627
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2801
3628
|
};
|
2802
3629
|
path: {
|
3630
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2803
3631
|
Type: components["parameters"]["Type"];
|
3632
|
+
/** @description The identifier value. */
|
2804
3633
|
ID: components["parameters"]["ID"];
|
2805
3634
|
};
|
3635
|
+
cookie?: never;
|
2806
3636
|
};
|
2807
3637
|
/** @description Participant information to be created. */
|
2808
3638
|
requestBody: {
|
@@ -2822,31 +3652,42 @@ export interface operations {
|
|
2822
3652
|
503: components["responses"]["503"];
|
2823
3653
|
};
|
2824
3654
|
};
|
2825
|
-
/**
|
2826
|
-
* Delete participant information
|
2827
|
-
* @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
2828
|
-
*
|
2829
|
-
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
2830
|
-
*/
|
2831
3655
|
ParticipantsByTypeAndID2: {
|
2832
3656
|
parameters: {
|
3657
|
+
query?: never;
|
2833
3658
|
header: {
|
3659
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2834
3660
|
"Content-Type": components["parameters"]["Content-Type"];
|
3661
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2835
3662
|
Date: components["parameters"]["Date"];
|
3663
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3664
|
+
*
|
3665
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2836
3666
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3667
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2837
3668
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3669
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2838
3670
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3671
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2839
3672
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3673
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2840
3674
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3675
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2841
3676
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3677
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2842
3678
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3679
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2843
3680
|
Accept: components["parameters"]["Accept"];
|
2844
3681
|
};
|
2845
3682
|
path: {
|
3683
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2846
3684
|
Type: components["parameters"]["Type"];
|
3685
|
+
/** @description The identifier value. */
|
2847
3686
|
ID: components["parameters"]["ID"];
|
2848
3687
|
};
|
3688
|
+
cookie?: never;
|
2849
3689
|
};
|
3690
|
+
requestBody?: never;
|
2850
3691
|
responses: {
|
2851
3692
|
202: components["responses"]["202"];
|
2852
3693
|
400: components["responses"]["400"];
|
@@ -2859,28 +3700,42 @@ export interface operations {
|
|
2859
3700
|
503: components["responses"]["503"];
|
2860
3701
|
};
|
2861
3702
|
};
|
2862
|
-
/**
|
2863
|
-
* Return participant information error
|
2864
|
-
* @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
|
2865
|
-
*/
|
2866
3703
|
ParticipantsErrorByTypeAndID: {
|
2867
3704
|
parameters: {
|
3705
|
+
query?: never;
|
2868
3706
|
header: {
|
3707
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2869
3708
|
"Content-Type": components["parameters"]["Content-Type"];
|
3709
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2870
3710
|
Date: components["parameters"]["Date"];
|
3711
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3712
|
+
*
|
3713
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2871
3714
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3715
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2872
3716
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3717
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2873
3718
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3719
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2874
3720
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3721
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2875
3722
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3723
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2876
3724
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3725
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2877
3726
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3727
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3728
|
+
*
|
3729
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2878
3730
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2879
3731
|
};
|
2880
3732
|
path: {
|
3733
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2881
3734
|
Type: components["parameters"]["Type"];
|
3735
|
+
/** @description The identifier value. */
|
2882
3736
|
ID: components["parameters"]["ID"];
|
2883
3737
|
};
|
3738
|
+
cookie?: never;
|
2884
3739
|
};
|
2885
3740
|
/** @description Details of the error returned. */
|
2886
3741
|
requestBody: {
|
@@ -2900,29 +3755,40 @@ export interface operations {
|
|
2900
3755
|
503: components["responses"]["503"];
|
2901
3756
|
};
|
2902
3757
|
};
|
2903
|
-
/**
|
2904
|
-
* GetServicesByServiceType
|
2905
|
-
* @description The HTTP request `GET /services/{ServiceType}` is used to retrieve the list of participants
|
2906
|
-
* that support a specified service.
|
2907
|
-
*/
|
2908
3758
|
GetServicesByServiceType: {
|
2909
3759
|
parameters: {
|
3760
|
+
query?: never;
|
2910
3761
|
header: {
|
3762
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2911
3763
|
"Content-Type": components["parameters"]["Content-Type"];
|
3764
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2912
3765
|
Date: components["parameters"]["Date"];
|
3766
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3767
|
+
*
|
3768
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2913
3769
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3770
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2914
3771
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3772
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2915
3773
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3774
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2916
3775
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3776
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2917
3777
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3778
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2918
3779
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3780
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2919
3781
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3782
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2920
3783
|
Accept: components["parameters"]["Accept"];
|
2921
3784
|
};
|
2922
3785
|
path: {
|
3786
|
+
/** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
2923
3787
|
ServiceType: components["parameters"]["ServiceType"];
|
2924
3788
|
};
|
3789
|
+
cookie?: never;
|
2925
3790
|
};
|
3791
|
+
requestBody?: never;
|
2926
3792
|
responses: {
|
2927
3793
|
202: components["responses"]["202"];
|
2928
3794
|
400: components["responses"]["400"];
|
@@ -2935,28 +3801,40 @@ export interface operations {
|
|
2935
3801
|
503: components["responses"]["503"];
|
2936
3802
|
};
|
2937
3803
|
};
|
2938
|
-
/**
|
2939
|
-
* PutServicesByServiceType
|
2940
|
-
* @description The HTTP request `PUT /services/{ServiceType}` is used to return list of participants
|
2941
|
-
* that support a specified service.
|
2942
|
-
*/
|
2943
3804
|
PutServicesByServiceType: {
|
2944
3805
|
parameters: {
|
3806
|
+
query?: never;
|
2945
3807
|
header: {
|
3808
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2946
3809
|
"Content-Type": components["parameters"]["Content-Type"];
|
3810
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2947
3811
|
Date: components["parameters"]["Date"];
|
3812
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3813
|
+
*
|
3814
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2948
3815
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3816
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2949
3817
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3818
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2950
3819
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3820
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2951
3821
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3822
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2952
3823
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3824
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2953
3825
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3826
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2954
3827
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3828
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3829
|
+
*
|
3830
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2955
3831
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2956
3832
|
};
|
2957
3833
|
path: {
|
3834
|
+
/** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
2958
3835
|
ServiceType: components["parameters"]["ServiceType"];
|
2959
3836
|
};
|
3837
|
+
cookie?: never;
|
2960
3838
|
};
|
2961
3839
|
requestBody: {
|
2962
3840
|
content: {
|
@@ -2975,27 +3853,40 @@ export interface operations {
|
|
2975
3853
|
503: components["responses"]["503"];
|
2976
3854
|
};
|
2977
3855
|
};
|
2978
|
-
/**
|
2979
|
-
* PutServicesByServiceTypeAndError
|
2980
|
-
* @description The HTTP request `PUT /services/{ServiceType}/error` is used to return error information
|
2981
|
-
*/
|
2982
3856
|
PutServicesByServiceTypeAndError: {
|
2983
3857
|
parameters: {
|
3858
|
+
query?: never;
|
2984
3859
|
header: {
|
3860
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2985
3861
|
"Content-Type": components["parameters"]["Content-Type"];
|
3862
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2986
3863
|
Date: components["parameters"]["Date"];
|
3864
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3865
|
+
*
|
3866
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2987
3867
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3868
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2988
3869
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3870
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
2989
3871
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3872
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2990
3873
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3874
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2991
3875
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3876
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2992
3877
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3878
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2993
3879
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3880
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3881
|
+
*
|
3882
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2994
3883
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2995
3884
|
};
|
2996
3885
|
path: {
|
3886
|
+
/** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */
|
2997
3887
|
ServiceType: components["parameters"]["ServiceType"];
|
2998
3888
|
};
|
3889
|
+
cookie?: never;
|
2999
3890
|
};
|
3000
3891
|
/** @description Details of the error returned. */
|
3001
3892
|
requestBody: {
|
@@ -3015,25 +3906,39 @@ export interface operations {
|
|
3015
3906
|
503: components["responses"]["503"];
|
3016
3907
|
};
|
3017
3908
|
};
|
3018
|
-
/**
|
3019
|
-
* ThirdpartyRequestsTransactionsPost
|
3020
|
-
* @description The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
|
3021
|
-
*/
|
3022
3909
|
ThirdpartyRequestsTransactionsPost: {
|
3023
3910
|
parameters: {
|
3911
|
+
query?: never;
|
3024
3912
|
header: {
|
3913
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3025
3914
|
"Content-Type": components["parameters"]["Content-Type"];
|
3915
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3026
3916
|
Date: components["parameters"]["Date"];
|
3917
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3918
|
+
*
|
3919
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3027
3920
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3921
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3028
3922
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3923
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3029
3924
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3925
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3030
3926
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3927
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3031
3928
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3929
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3032
3930
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3931
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3033
3932
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3933
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3034
3934
|
Accept: components["parameters"]["Accept"];
|
3935
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3936
|
+
*
|
3937
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3035
3938
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3036
3939
|
};
|
3940
|
+
path?: never;
|
3941
|
+
cookie?: never;
|
3037
3942
|
};
|
3038
3943
|
/** @description Transaction request to be created. */
|
3039
3944
|
requestBody: {
|
@@ -3053,29 +3958,40 @@ export interface operations {
|
|
3053
3958
|
503: components["responses"]["503"];
|
3054
3959
|
};
|
3055
3960
|
};
|
3056
|
-
/**
|
3057
|
-
* GetThirdpartyTransactionRequests
|
3058
|
-
* @description The HTTP request `GET /thirdpartyRequests/transactions/{ID}` is used to request the
|
3059
|
-
* retrieval of a third party transaction request.
|
3060
|
-
*/
|
3061
3961
|
GetThirdpartyTransactionRequests: {
|
3062
3962
|
parameters: {
|
3963
|
+
query?: never;
|
3063
3964
|
header: {
|
3965
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3064
3966
|
"Content-Type": components["parameters"]["Content-Type"];
|
3967
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3065
3968
|
Date: components["parameters"]["Date"];
|
3969
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3970
|
+
*
|
3971
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3066
3972
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3973
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3067
3974
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3975
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3068
3976
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3977
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3069
3978
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3979
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3070
3980
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3981
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3071
3982
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3983
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3072
3984
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3985
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3073
3986
|
Accept: components["parameters"]["Accept"];
|
3074
3987
|
};
|
3075
3988
|
path: {
|
3989
|
+
/** @description The identifier value. */
|
3076
3990
|
ID: components["parameters"]["ID"];
|
3077
3991
|
};
|
3992
|
+
cookie?: never;
|
3078
3993
|
};
|
3994
|
+
requestBody?: never;
|
3079
3995
|
responses: {
|
3080
3996
|
202: components["responses"]["202"];
|
3081
3997
|
400: components["responses"]["400"];
|
@@ -3088,38 +4004,46 @@ export interface operations {
|
|
3088
4004
|
503: components["responses"]["503"];
|
3089
4005
|
};
|
3090
4006
|
};
|
3091
|
-
/**
|
3092
|
-
* UpdateThirdPartyTransactionRequests
|
3093
|
-
* @description The HTTP request `PUT /thirdpartyRequests/transactions/{ID}` is used by the DFSP to inform the client about
|
3094
|
-
* the status of a previously requested thirdparty transaction request.
|
3095
|
-
*
|
3096
|
-
* Switch(Thirdparty API Adapter) -> PISP
|
3097
|
-
*/
|
3098
4007
|
UpdateThirdPartyTransactionRequests: {
|
3099
4008
|
parameters: {
|
4009
|
+
query?: never;
|
3100
4010
|
header: {
|
4011
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3101
4012
|
"Content-Type": components["parameters"]["Content-Type"];
|
4013
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3102
4014
|
Date: components["parameters"]["Date"];
|
4015
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4016
|
+
*
|
4017
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3103
4018
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4019
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3104
4020
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4021
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3105
4022
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4023
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3106
4024
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4025
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3107
4026
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4027
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3108
4028
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4029
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3109
4030
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4031
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4032
|
+
*
|
4033
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3110
4034
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3111
4035
|
};
|
3112
4036
|
path: {
|
4037
|
+
/** @description The identifier value. */
|
3113
4038
|
ID: components["parameters"]["ID"];
|
3114
4039
|
};
|
4040
|
+
cookie?: never;
|
3115
4041
|
};
|
3116
4042
|
requestBody: {
|
3117
4043
|
content: {
|
3118
|
-
/**
|
3119
|
-
*
|
3120
|
-
*
|
3121
|
-
* }
|
3122
|
-
*/
|
4044
|
+
/** @example {
|
4045
|
+
* "transactionRequestState": "RECEIVED"
|
4046
|
+
* } */
|
3123
4047
|
"application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPutResponse"];
|
3124
4048
|
};
|
3125
4049
|
};
|
@@ -3135,40 +4059,49 @@ export interface operations {
|
|
3135
4059
|
503: components["responses"]["503"];
|
3136
4060
|
};
|
3137
4061
|
};
|
3138
|
-
/**
|
3139
|
-
* NotifyThirdpartyTransactionRequests
|
3140
|
-
* @description The HTTP request `PATCH /thirdpartyRequests/transactions/{ID}` is used to
|
3141
|
-
* notify a thirdparty of the outcome of a transaction request.
|
3142
|
-
*
|
3143
|
-
* Switch(Thirdparty API Adapter) -> PISP
|
3144
|
-
*/
|
3145
4062
|
NotifyThirdpartyTransactionRequests: {
|
3146
4063
|
parameters: {
|
4064
|
+
query?: never;
|
3147
4065
|
header: {
|
4066
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3148
4067
|
"Content-Type": components["parameters"]["Content-Type"];
|
4068
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3149
4069
|
Date: components["parameters"]["Date"];
|
4070
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4071
|
+
*
|
4072
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3150
4073
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4074
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3151
4075
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4076
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3152
4077
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4078
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3153
4079
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4080
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3154
4081
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4082
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3155
4083
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4084
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3156
4085
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4086
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3157
4087
|
Accept: components["parameters"]["Accept"];
|
4088
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4089
|
+
*
|
4090
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3158
4091
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3159
4092
|
};
|
3160
4093
|
path: {
|
4094
|
+
/** @description The identifier value. */
|
3161
4095
|
ID: components["parameters"]["ID"];
|
3162
4096
|
};
|
4097
|
+
cookie?: never;
|
3163
4098
|
};
|
3164
4099
|
requestBody: {
|
3165
4100
|
content: {
|
3166
|
-
/**
|
3167
|
-
*
|
3168
|
-
*
|
3169
|
-
*
|
3170
|
-
* }
|
3171
|
-
*/
|
4101
|
+
/** @example {
|
4102
|
+
* "transactionRequestState": "ACCEPTED",
|
4103
|
+
* "transactionState": "COMMITTED"
|
4104
|
+
* } */
|
3172
4105
|
"application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPatchResponse"];
|
3173
4106
|
};
|
3174
4107
|
};
|
@@ -3184,30 +4117,40 @@ export interface operations {
|
|
3184
4117
|
503: components["responses"]["503"];
|
3185
4118
|
};
|
3186
4119
|
};
|
3187
|
-
/**
|
3188
|
-
* ThirdpartyTransactionRequestsError
|
3189
|
-
* @description If the server is unable to find the transaction request, or another processing error occurs,
|
3190
|
-
* the error callback `PUT /thirdpartyRequests/transactions/{ID}/error` is used.
|
3191
|
-
* The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of
|
3192
|
-
* the thirdparty transaction request.
|
3193
|
-
*/
|
3194
4120
|
ThirdpartyTransactionRequestsError: {
|
3195
4121
|
parameters: {
|
4122
|
+
query?: never;
|
3196
4123
|
header: {
|
4124
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3197
4125
|
"Content-Type": components["parameters"]["Content-Type"];
|
4126
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3198
4127
|
Date: components["parameters"]["Date"];
|
4128
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4129
|
+
*
|
4130
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3199
4131
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4132
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3200
4133
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4134
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3201
4135
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4136
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3202
4137
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4138
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3203
4139
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4140
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3204
4141
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4142
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3205
4143
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4144
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4145
|
+
*
|
4146
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3206
4147
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3207
4148
|
};
|
3208
4149
|
path: {
|
4150
|
+
/** @description The identifier value. */
|
3209
4151
|
ID: components["parameters"]["ID"];
|
3210
4152
|
};
|
4153
|
+
cookie?: never;
|
3211
4154
|
};
|
3212
4155
|
/** @description Error information returned. */
|
3213
4156
|
requestBody: {
|
@@ -3227,25 +4170,39 @@ export interface operations {
|
|
3227
4170
|
503: components["responses"]["503"];
|
3228
4171
|
};
|
3229
4172
|
};
|
3230
|
-
/**
|
3231
|
-
* PostThirdpartyRequestsAuthorizations
|
3232
|
-
* @description The HTTP request **POST /thirdpartyRequests/authorizations** is used to request the validation by a customer for the transfer described in the request.
|
3233
|
-
*/
|
3234
4173
|
PostThirdpartyRequestsAuthorizations: {
|
3235
4174
|
parameters: {
|
4175
|
+
query?: never;
|
3236
4176
|
header: {
|
4177
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3237
4178
|
"Content-Type": components["parameters"]["Content-Type"];
|
4179
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3238
4180
|
Date: components["parameters"]["Date"];
|
4181
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4182
|
+
*
|
4183
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3239
4184
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4185
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3240
4186
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4187
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3241
4188
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4189
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3242
4190
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4191
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3243
4192
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4193
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3244
4194
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4195
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3245
4196
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4197
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3246
4198
|
Accept: components["parameters"]["Accept"];
|
4199
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4200
|
+
*
|
4201
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3247
4202
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3248
4203
|
};
|
4204
|
+
path?: never;
|
4205
|
+
cookie?: never;
|
3249
4206
|
};
|
3250
4207
|
/** @description Authorization request details */
|
3251
4208
|
requestBody: {
|
@@ -3265,30 +4222,40 @@ export interface operations {
|
|
3265
4222
|
503: components["responses"]["503"];
|
3266
4223
|
};
|
3267
4224
|
};
|
3268
|
-
/**
|
3269
|
-
* GetThirdpartyRequestsAuthorizationsById
|
3270
|
-
* @description The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating
|
3271
|
-
* to a previously issued authorization request. The *{ID}* in the request should match the
|
3272
|
-
* `authorizationRequestId` which was given when the authorization request was created.
|
3273
|
-
*/
|
3274
4225
|
GetThirdpartyRequestsAuthorizationsById: {
|
3275
4226
|
parameters: {
|
4227
|
+
query?: never;
|
3276
4228
|
header: {
|
4229
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3277
4230
|
"Content-Type": components["parameters"]["Content-Type"];
|
4231
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3278
4232
|
Date: components["parameters"]["Date"];
|
4233
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4234
|
+
*
|
4235
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3279
4236
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4237
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3280
4238
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4239
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3281
4240
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4241
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3282
4242
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4243
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3283
4244
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4245
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3284
4246
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4247
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3285
4248
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4249
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3286
4250
|
Accept: components["parameters"]["Accept"];
|
3287
4251
|
};
|
3288
4252
|
path: {
|
4253
|
+
/** @description The identifier value. */
|
3289
4254
|
ID: components["parameters"]["ID"];
|
3290
4255
|
};
|
4256
|
+
cookie?: never;
|
3291
4257
|
};
|
4258
|
+
requestBody?: never;
|
3292
4259
|
responses: {
|
3293
4260
|
202: components["responses"]["202"];
|
3294
4261
|
400: components["responses"]["400"];
|
@@ -3301,31 +4268,40 @@ export interface operations {
|
|
3301
4268
|
503: components["responses"]["503"];
|
3302
4269
|
};
|
3303
4270
|
};
|
3304
|
-
/**
|
3305
|
-
* PutThirdpartyRequestsAuthorizationsById
|
3306
|
-
* @description After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the
|
3307
|
-
* transaction to their user, and request that the client sign the `challenge` field using the credential
|
3308
|
-
* they previously registered.
|
3309
|
-
*
|
3310
|
-
* The signed challenge will be sent back by the PISP in **PUT /thirdpartyRequests/authorizations/**_{ID}_:
|
3311
|
-
*/
|
3312
4271
|
PutThirdpartyRequestsAuthorizationsById: {
|
3313
4272
|
parameters: {
|
4273
|
+
query?: never;
|
3314
4274
|
header: {
|
4275
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3315
4276
|
"Content-Type": components["parameters"]["Content-Type"];
|
4277
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3316
4278
|
Date: components["parameters"]["Date"];
|
4279
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4280
|
+
*
|
4281
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3317
4282
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4283
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3318
4284
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4285
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3319
4286
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4287
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3320
4288
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4289
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3321
4290
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4291
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3322
4292
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4293
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3323
4294
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4295
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4296
|
+
*
|
4297
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3324
4298
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3325
4299
|
};
|
3326
4300
|
path: {
|
4301
|
+
/** @description The identifier value. */
|
3327
4302
|
ID: components["parameters"]["ID"];
|
3328
4303
|
};
|
4304
|
+
cookie?: never;
|
3329
4305
|
};
|
3330
4306
|
/** @description Signed authorization object */
|
3331
4307
|
requestBody: {
|
@@ -3345,34 +4321,40 @@ export interface operations {
|
|
3345
4321
|
503: components["responses"]["503"];
|
3346
4322
|
};
|
3347
4323
|
};
|
3348
|
-
/**
|
3349
|
-
* PutThirdpartyRequestsAuthorizationsByIdAndError
|
3350
|
-
* @description The HTTP request `PUT /thirdpartyRequests/authorizations/{ID}/error` is used by the DFSP or PISP to inform
|
3351
|
-
* the other party that something went wrong with a Thirdparty Transaction Authorization Request.
|
3352
|
-
*
|
3353
|
-
* The PISP may use this to tell the DFSP that the Thirdparty Transaction Authorization Request is invalid or doesn't
|
3354
|
-
* match a `transactionRequestId`.
|
3355
|
-
*
|
3356
|
-
* The DFSP may use this to tell the PISP that the signed challenge returned in `PUT /thirdpartyRequest/authorizations/{ID}`
|
3357
|
-
* was invalid.
|
3358
|
-
*/
|
3359
4324
|
PutThirdpartyRequestsAuthorizationsByIdAndError: {
|
3360
4325
|
parameters: {
|
4326
|
+
query?: never;
|
3361
4327
|
header: {
|
4328
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3362
4329
|
"Content-Type": components["parameters"]["Content-Type"];
|
4330
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3363
4331
|
Date: components["parameters"]["Date"];
|
4332
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4333
|
+
*
|
4334
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3364
4335
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4336
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3365
4337
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4338
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3366
4339
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4340
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3367
4341
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4342
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3368
4343
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4344
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3369
4345
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4346
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3370
4347
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4348
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4349
|
+
*
|
4350
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3371
4351
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3372
4352
|
};
|
3373
4353
|
path: {
|
4354
|
+
/** @description The identifier value. */
|
3374
4355
|
ID: components["parameters"]["ID"];
|
3375
4356
|
};
|
4357
|
+
cookie?: never;
|
3376
4358
|
};
|
3377
4359
|
/** @description Error information returned. */
|
3378
4360
|
requestBody: {
|
@@ -3392,25 +4374,39 @@ export interface operations {
|
|
3392
4374
|
503: components["responses"]["503"];
|
3393
4375
|
};
|
3394
4376
|
};
|
3395
|
-
/**
|
3396
|
-
* PostThirdpartyRequestsVerifications
|
3397
|
-
* @description The HTTP request `POST /thirdpartyRequests/verifications` is used by the DFSP to verify a third party authorization.
|
3398
|
-
*/
|
3399
4377
|
PostThirdpartyRequestsVerifications: {
|
3400
4378
|
parameters: {
|
4379
|
+
query?: never;
|
3401
4380
|
header: {
|
4381
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3402
4382
|
"Content-Type": components["parameters"]["Content-Type"];
|
4383
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3403
4384
|
Date: components["parameters"]["Date"];
|
4385
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4386
|
+
*
|
4387
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3404
4388
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4389
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3405
4390
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4391
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3406
4392
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4393
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3407
4394
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4395
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3408
4396
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4397
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3409
4398
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4399
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3410
4400
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4401
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3411
4402
|
Accept: components["parameters"]["Accept"];
|
4403
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4404
|
+
*
|
4405
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3412
4406
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3413
4407
|
};
|
4408
|
+
path?: never;
|
4409
|
+
cookie?: never;
|
3414
4410
|
};
|
3415
4411
|
/** @description The thirdparty authorization details to verify */
|
3416
4412
|
requestBody: {
|
@@ -3430,30 +4426,40 @@ export interface operations {
|
|
3430
4426
|
503: components["responses"]["503"];
|
3431
4427
|
};
|
3432
4428
|
};
|
3433
|
-
/**
|
3434
|
-
* GetThirdpartyRequestsVerificationsById
|
3435
|
-
* @description The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get
|
3436
|
-
* information regarding a previously created or requested authorization. The *{ID}*
|
3437
|
-
* in the URI should contain the verification request ID
|
3438
|
-
*/
|
3439
4429
|
GetThirdpartyRequestsVerificationsById: {
|
3440
4430
|
parameters: {
|
4431
|
+
query?: never;
|
3441
4432
|
header: {
|
4433
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3442
4434
|
"Content-Type": components["parameters"]["Content-Type"];
|
4435
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3443
4436
|
Date: components["parameters"]["Date"];
|
4437
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4438
|
+
*
|
4439
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3444
4440
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4441
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3445
4442
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4443
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3446
4444
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4445
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3447
4446
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4447
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3448
4448
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4449
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3449
4450
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4451
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3450
4452
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4453
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3451
4454
|
Accept: components["parameters"]["Accept"];
|
3452
4455
|
};
|
3453
4456
|
path: {
|
4457
|
+
/** @description The identifier value. */
|
3454
4458
|
ID: components["parameters"]["ID"];
|
3455
4459
|
};
|
4460
|
+
cookie?: never;
|
3456
4461
|
};
|
4462
|
+
requestBody?: never;
|
3457
4463
|
responses: {
|
3458
4464
|
202: components["responses"]["202"];
|
3459
4465
|
400: components["responses"]["400"];
|
@@ -3466,38 +4472,47 @@ export interface operations {
|
|
3466
4472
|
503: components["responses"]["503"];
|
3467
4473
|
};
|
3468
4474
|
};
|
3469
|
-
/**
|
3470
|
-
* PutThirdpartyRequestsVerificationsById
|
3471
|
-
* @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
|
3472
|
-
* If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`.
|
3473
|
-
* In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
|
3474
|
-
*/
|
3475
4475
|
PutThirdpartyRequestsVerificationsById: {
|
3476
4476
|
parameters: {
|
4477
|
+
query?: never;
|
3477
4478
|
header: {
|
4479
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3478
4480
|
"Content-Type": components["parameters"]["Content-Type"];
|
4481
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3479
4482
|
Date: components["parameters"]["Date"];
|
4483
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4484
|
+
*
|
4485
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3480
4486
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4487
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3481
4488
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4489
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3482
4490
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4491
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3483
4492
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4493
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3484
4494
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4495
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3485
4496
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4497
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3486
4498
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4499
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4500
|
+
*
|
4501
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3487
4502
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3488
4503
|
};
|
3489
4504
|
path: {
|
4505
|
+
/** @description The identifier value. */
|
3490
4506
|
ID: components["parameters"]["ID"];
|
3491
4507
|
};
|
4508
|
+
cookie?: never;
|
3492
4509
|
};
|
3493
4510
|
/** @description The result of validating the Thirdparty Transaction Request */
|
3494
4511
|
requestBody: {
|
3495
4512
|
content: {
|
3496
|
-
/**
|
3497
|
-
*
|
3498
|
-
*
|
3499
|
-
* }
|
3500
|
-
*/
|
4513
|
+
/** @example {
|
4514
|
+
* "authenticationResponse": "VERIFIED"
|
4515
|
+
* } */
|
3501
4516
|
"application/json": components["schemas"]["ThirdpartyRequestsVerificationsIDPutResponse"];
|
3502
4517
|
};
|
3503
4518
|
};
|
@@ -3513,28 +4528,40 @@ export interface operations {
|
|
3513
4528
|
503: components["responses"]["503"];
|
3514
4529
|
};
|
3515
4530
|
};
|
3516
|
-
/**
|
3517
|
-
* PutThirdpartyRequestsVerificationsByIdAndError
|
3518
|
-
* @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}/error` is used by the Auth-Service to inform
|
3519
|
-
* the DFSP of a failure in validating or looking up the verification of a Thirdparty Transaction Request.
|
3520
|
-
*/
|
3521
4531
|
PutThirdpartyRequestsVerificationsByIdAndError: {
|
3522
4532
|
parameters: {
|
4533
|
+
query?: never;
|
3523
4534
|
header: {
|
4535
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3524
4536
|
"Content-Type": components["parameters"]["Content-Type"];
|
4537
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3525
4538
|
Date: components["parameters"]["Date"];
|
4539
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4540
|
+
*
|
4541
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3526
4542
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4543
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3527
4544
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4545
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
3528
4546
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4547
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3529
4548
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4549
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3530
4550
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4551
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3531
4552
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4553
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3532
4554
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4555
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4556
|
+
*
|
4557
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3533
4558
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3534
4559
|
};
|
3535
4560
|
path: {
|
4561
|
+
/** @description The identifier value. */
|
3536
4562
|
ID: components["parameters"]["ID"];
|
3537
4563
|
};
|
4564
|
+
cookie?: never;
|
3538
4565
|
};
|
3539
4566
|
/** @description Error information returned. */
|
3540
4567
|
requestBody: {
|