@mojaloop/api-snippets 17.6.0-snapshot.0 → 17.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/audit-ci.jsonc +2 -1
- package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +1 -1
- package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +1 -1
- package/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +4735 -0
- package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +1 -1
- package/docs/index.html +1 -0
- package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +7 -7
- package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +7 -7
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1 -1
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +1 -1
- package/docs/thirdparty-openapi3-snippets.yaml +1 -1
- package/fspiop/v1_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyCode.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyCode.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AnyBICDec2014Identifier.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BICFIDec2014Identifier.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml +39 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml +36 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml +125 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml +69 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorCode.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorDescription.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformation.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformationResponse.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact4AlphaNumericText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml +61 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Extension.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionKey.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionList.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionValue.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalAccountIdentification1Code.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCashAccountType1Code.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCategoryPurpose1Code.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml +83 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml +81 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml +72 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml +35 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml +58 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODate.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISOYear.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml +33 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml +3 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LEIIdentifier.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max105Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max10Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max128Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max140Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max15NumericText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max16Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max2048Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max256Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max34Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max350Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max35Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max4Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max70Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml +19 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml +19 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml +35 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml +79 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml +37 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml +34 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml +42 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml +18 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml +18 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PhoneNumber.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml +55 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml +61 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml +19 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml +40 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml +27 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml +20 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml +38 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml +43 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/openapi.yaml +53 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}.yaml +81 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml +120 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}.yaml +82 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_error.yaml +50 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}.yaml +83 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}_error.yaml +51 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}.yaml +80 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml +119 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}_error.yaml +49 -0
- package/lib/fspiop/v1_0/openapi.d.ts +1494 -409
- package/lib/fspiop/v1_1/openapi.d.ts +1495 -417
- package/lib/fspiop/v2_0/json-schemas.json +39 -39
- package/lib/fspiop/v2_0/openapi.d.ts +1945 -560
- package/lib/fspiop/v2_0_ISO20022/index.d.ts +3 -0
- package/lib/fspiop/v2_0_ISO20022/index.js +9 -0
- package/lib/fspiop/v2_0_ISO20022/index.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/json-schemas.json +107991 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.d.ts +5162 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.js +7 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.d.ts +95738 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.js +171 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/types.d.ts +164 -0
- package/lib/fspiop/v2_0_ISO20022/types.js +4 -0
- package/lib/fspiop/v2_0_ISO20022/types.js.map +1 -0
- package/lib/index.d.ts +3 -0
- package/lib/index.js +4 -1
- package/lib/index.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +55 -55
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +384 -74
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +55 -55
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +543 -109
- package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +66 -66
- package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +503 -139
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +72 -72
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +694 -184
- package/lib/thirdparty/openapi.d.ts +1639 -612
- package/package.json +30 -27
- package/sdk-bulk.yaml +1 -1
- package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml +6 -6
- package/sdk-scheme-adapter/v2_0_0/components/schemas/CorrelationId.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +6 -6
- package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml +1 -1
@@ -4,6 +4,38 @@
|
|
4
4
|
*/
|
5
5
|
export interface paths {
|
6
6
|
"/participants/{Type}/{ID}": {
|
7
|
+
parameters: {
|
8
|
+
query?: never;
|
9
|
+
header: {
|
10
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
11
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
12
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
13
|
+
Date: components["parameters"]["Date"];
|
14
|
+
/** @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.
|
15
|
+
*
|
16
|
+
* **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`. */
|
17
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
18
|
+
/** @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`). */
|
19
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
20
|
+
/** @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. */
|
21
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
22
|
+
/** @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. */
|
23
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
24
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
25
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
26
|
+
/** @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). */
|
27
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
28
|
+
/** @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). */
|
29
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
30
|
+
};
|
31
|
+
path: {
|
32
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
33
|
+
Type: components["parameters"]["Type"];
|
34
|
+
/** @description The identifier value. */
|
35
|
+
ID: components["parameters"]["ID"];
|
36
|
+
};
|
37
|
+
cookie?: never;
|
38
|
+
};
|
7
39
|
/**
|
8
40
|
* Look up participant information
|
9
41
|
* @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.
|
@@ -23,35 +55,69 @@ export interface paths {
|
|
23
55
|
* Delete participant information
|
24
56
|
* @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.
|
25
57
|
*
|
26
|
-
*
|
58
|
+
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
27
59
|
*/
|
28
60
|
delete: operations["ParticipantsByTypeAndID2"];
|
61
|
+
options?: never;
|
62
|
+
head?: never;
|
63
|
+
patch?: never;
|
64
|
+
trace?: never;
|
65
|
+
};
|
66
|
+
"/participants/{Type}/{ID}/error": {
|
29
67
|
parameters: {
|
68
|
+
query?: never;
|
69
|
+
header?: never;
|
70
|
+
path?: never;
|
71
|
+
cookie?: never;
|
72
|
+
};
|
73
|
+
get?: never;
|
74
|
+
/**
|
75
|
+
* Return participant information error
|
76
|
+
* @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.
|
77
|
+
*/
|
78
|
+
put: operations["ParticipantsErrorByTypeAndID"];
|
79
|
+
post?: never;
|
80
|
+
delete?: never;
|
81
|
+
options?: never;
|
82
|
+
head?: never;
|
83
|
+
patch?: never;
|
84
|
+
trace?: never;
|
85
|
+
};
|
86
|
+
"/participants/{Type}/{ID}/{SubId}": {
|
87
|
+
parameters: {
|
88
|
+
query?: never;
|
30
89
|
header: {
|
90
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
31
91
|
"Content-Type": components["parameters"]["Content-Type"];
|
92
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
32
93
|
Date: components["parameters"]["Date"];
|
94
|
+
/** @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.
|
95
|
+
*
|
96
|
+
* **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`. */
|
33
97
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
98
|
+
/** @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`). */
|
34
99
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
100
|
+
/** @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. */
|
35
101
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
102
|
+
/** @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. */
|
36
103
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
104
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
37
105
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
106
|
+
/** @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). */
|
38
107
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
108
|
+
/** @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). */
|
39
109
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
40
110
|
};
|
41
111
|
path: {
|
112
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
42
113
|
Type: components["parameters"]["Type"];
|
114
|
+
/** @description The identifier value. */
|
43
115
|
ID: components["parameters"]["ID"];
|
116
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
117
|
+
SubId: components["parameters"]["SubId"];
|
44
118
|
};
|
119
|
+
cookie?: never;
|
45
120
|
};
|
46
|
-
};
|
47
|
-
"/participants/{Type}/{ID}/error": {
|
48
|
-
/**
|
49
|
-
* Return participant information error
|
50
|
-
* @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.
|
51
|
-
*/
|
52
|
-
put: operations["ParticipantsErrorByTypeAndID"];
|
53
|
-
};
|
54
|
-
"/participants/{Type}/{ID}/{SubId}": {
|
55
121
|
/**
|
56
122
|
* Look up participant information
|
57
123
|
* @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.
|
@@ -71,179 +137,375 @@ export interface paths {
|
|
71
137
|
* Delete participant information
|
72
138
|
* @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.
|
73
139
|
*
|
74
|
-
*
|
140
|
+
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
75
141
|
*/
|
76
142
|
delete: operations["ParticipantsSubIdByTypeAndID2"];
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
82
|
-
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
83
|
-
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
84
|
-
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
85
|
-
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
86
|
-
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
87
|
-
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
88
|
-
};
|
89
|
-
path: {
|
90
|
-
Type: components["parameters"]["Type"];
|
91
|
-
ID: components["parameters"]["ID"];
|
92
|
-
SubId: components["parameters"]["SubId"];
|
93
|
-
};
|
94
|
-
};
|
143
|
+
options?: never;
|
144
|
+
head?: never;
|
145
|
+
patch?: never;
|
146
|
+
trace?: never;
|
95
147
|
};
|
96
148
|
"/participants/{Type}/{ID}/{SubId}/error": {
|
149
|
+
parameters: {
|
150
|
+
query?: never;
|
151
|
+
header?: never;
|
152
|
+
path?: never;
|
153
|
+
cookie?: never;
|
154
|
+
};
|
155
|
+
get?: never;
|
97
156
|
/**
|
98
157
|
* Return participant information error
|
99
158
|
* @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.
|
100
159
|
*/
|
101
160
|
put: operations["ParticipantsSubIdErrorByTypeAndID"];
|
161
|
+
post?: never;
|
162
|
+
delete?: never;
|
163
|
+
options?: never;
|
164
|
+
head?: never;
|
165
|
+
patch?: never;
|
166
|
+
trace?: never;
|
102
167
|
};
|
103
168
|
"/participants": {
|
169
|
+
parameters: {
|
170
|
+
query?: never;
|
171
|
+
header?: never;
|
172
|
+
path?: never;
|
173
|
+
cookie?: never;
|
174
|
+
};
|
175
|
+
get?: never;
|
176
|
+
put?: never;
|
104
177
|
/**
|
105
178
|
* Create bulk participant information
|
106
179
|
* @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.
|
107
180
|
*/
|
108
181
|
post: operations["Participants1"];
|
182
|
+
delete?: never;
|
183
|
+
options?: never;
|
184
|
+
head?: never;
|
185
|
+
patch?: never;
|
186
|
+
trace?: never;
|
109
187
|
};
|
110
188
|
"/participants/{ID}": {
|
189
|
+
parameters: {
|
190
|
+
query?: never;
|
191
|
+
header?: never;
|
192
|
+
path?: never;
|
193
|
+
cookie?: never;
|
194
|
+
};
|
195
|
+
get?: never;
|
111
196
|
/**
|
112
197
|
* Return bulk participant information
|
113
198
|
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
114
199
|
*/
|
115
200
|
put: operations["putParticipantsByID"];
|
201
|
+
post?: never;
|
202
|
+
delete?: never;
|
203
|
+
options?: never;
|
204
|
+
head?: never;
|
205
|
+
patch?: never;
|
206
|
+
trace?: never;
|
116
207
|
};
|
117
208
|
"/participants/{ID}/error": {
|
209
|
+
parameters: {
|
210
|
+
query?: never;
|
211
|
+
header?: never;
|
212
|
+
path?: never;
|
213
|
+
cookie?: never;
|
214
|
+
};
|
215
|
+
get?: never;
|
118
216
|
/**
|
119
217
|
* Return bulk participant information error
|
120
218
|
* @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.
|
121
219
|
*/
|
122
220
|
put: operations["ParticipantsByIDAndError"];
|
221
|
+
post?: never;
|
222
|
+
delete?: never;
|
223
|
+
options?: never;
|
224
|
+
head?: never;
|
225
|
+
patch?: never;
|
226
|
+
trace?: never;
|
123
227
|
};
|
124
228
|
"/parties/{Type}/{ID}": {
|
125
|
-
/**
|
126
|
-
* Look up party information
|
127
|
-
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
128
|
-
*/
|
129
|
-
get: operations["PartiesByTypeAndID"];
|
130
|
-
/**
|
131
|
-
* Return party information
|
132
|
-
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
133
|
-
*/
|
134
|
-
put: operations["PartiesByTypeAndID2"];
|
135
229
|
parameters: {
|
230
|
+
query?: never;
|
136
231
|
header: {
|
232
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
137
233
|
"Content-Type": components["parameters"]["Content-Type"];
|
234
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
138
235
|
Date: components["parameters"]["Date"];
|
236
|
+
/** @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.
|
237
|
+
*
|
238
|
+
* **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`. */
|
139
239
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
240
|
+
/** @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`). */
|
140
241
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
242
|
+
/** @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. */
|
141
243
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
244
|
+
/** @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. */
|
142
245
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
246
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
143
247
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
248
|
+
/** @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). */
|
144
249
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
250
|
+
/** @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). */
|
145
251
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
146
252
|
};
|
147
253
|
path: {
|
254
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
148
255
|
Type: components["parameters"]["Type"];
|
256
|
+
/** @description The identifier value. */
|
149
257
|
ID: components["parameters"]["ID"];
|
150
258
|
};
|
259
|
+
cookie?: never;
|
151
260
|
};
|
261
|
+
/**
|
262
|
+
* Look up party information
|
263
|
+
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
264
|
+
*/
|
265
|
+
get: operations["PartiesByTypeAndID"];
|
266
|
+
/**
|
267
|
+
* Return party information
|
268
|
+
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
269
|
+
*/
|
270
|
+
put: operations["PartiesByTypeAndID2"];
|
271
|
+
post?: never;
|
272
|
+
delete?: never;
|
273
|
+
options?: never;
|
274
|
+
head?: never;
|
275
|
+
patch?: never;
|
276
|
+
trace?: never;
|
152
277
|
};
|
153
278
|
"/parties/{Type}/{ID}/error": {
|
279
|
+
parameters: {
|
280
|
+
query?: never;
|
281
|
+
header?: never;
|
282
|
+
path?: never;
|
283
|
+
cookie?: never;
|
284
|
+
};
|
285
|
+
get?: never;
|
154
286
|
/**
|
155
287
|
* Return party information error
|
156
288
|
* @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used.
|
157
289
|
*/
|
158
290
|
put: operations["PartiesErrorByTypeAndID"];
|
291
|
+
post?: never;
|
292
|
+
delete?: never;
|
293
|
+
options?: never;
|
294
|
+
head?: never;
|
295
|
+
patch?: never;
|
296
|
+
trace?: never;
|
159
297
|
};
|
160
298
|
"/parties/{Type}/{ID}/{SubId}": {
|
161
|
-
/**
|
162
|
-
* Look up party information
|
163
|
-
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
164
|
-
*/
|
165
|
-
get: operations["PartiesSubIdByTypeAndID"];
|
166
|
-
/**
|
167
|
-
* Return party information
|
168
|
-
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
169
|
-
*/
|
170
|
-
put: operations["PartiesSubIdByTypeAndIDPut"];
|
171
299
|
parameters: {
|
300
|
+
query?: never;
|
172
301
|
header: {
|
302
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
173
303
|
"Content-Type": components["parameters"]["Content-Type"];
|
304
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
174
305
|
Date: components["parameters"]["Date"];
|
306
|
+
/** @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.
|
307
|
+
*
|
308
|
+
* **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`. */
|
175
309
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
310
|
+
/** @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`). */
|
176
311
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
312
|
+
/** @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. */
|
177
313
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
314
|
+
/** @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. */
|
178
315
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
316
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
179
317
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
318
|
+
/** @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). */
|
180
319
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
320
|
+
/** @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
321
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
182
322
|
};
|
183
323
|
path: {
|
324
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
184
325
|
Type: components["parameters"]["Type"];
|
326
|
+
/** @description The identifier value. */
|
185
327
|
ID: components["parameters"]["ID"];
|
328
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
186
329
|
SubId: components["parameters"]["SubId"];
|
187
330
|
};
|
331
|
+
cookie?: never;
|
188
332
|
};
|
333
|
+
/**
|
334
|
+
* Look up party information
|
335
|
+
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
336
|
+
*/
|
337
|
+
get: operations["PartiesSubIdByTypeAndID"];
|
338
|
+
/**
|
339
|
+
* Return party information
|
340
|
+
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
341
|
+
*/
|
342
|
+
put: operations["PartiesSubIdByTypeAndIDPut"];
|
343
|
+
post?: never;
|
344
|
+
delete?: never;
|
345
|
+
options?: never;
|
346
|
+
head?: never;
|
347
|
+
patch?: never;
|
348
|
+
trace?: never;
|
189
349
|
};
|
190
350
|
"/parties/{Type}/{ID}/{SubId}/error": {
|
351
|
+
parameters: {
|
352
|
+
query?: never;
|
353
|
+
header?: never;
|
354
|
+
path?: never;
|
355
|
+
cookie?: never;
|
356
|
+
};
|
357
|
+
get?: never;
|
191
358
|
/**
|
192
359
|
* Return party information error
|
193
360
|
* @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used.
|
194
361
|
*/
|
195
362
|
put: operations["PartiesSubIdErrorByTypeAndID"];
|
363
|
+
post?: never;
|
364
|
+
delete?: never;
|
365
|
+
options?: never;
|
366
|
+
head?: never;
|
367
|
+
patch?: never;
|
368
|
+
trace?: never;
|
196
369
|
};
|
197
370
|
"/transactionRequests": {
|
371
|
+
parameters: {
|
372
|
+
query?: never;
|
373
|
+
header?: never;
|
374
|
+
path?: never;
|
375
|
+
cookie?: never;
|
376
|
+
};
|
377
|
+
get?: never;
|
378
|
+
put?: never;
|
198
379
|
/**
|
199
380
|
* Perform transaction request
|
200
381
|
* @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
|
201
382
|
*/
|
202
383
|
post: operations["TransactionRequests"];
|
384
|
+
delete?: never;
|
385
|
+
options?: never;
|
386
|
+
head?: never;
|
387
|
+
patch?: never;
|
388
|
+
trace?: never;
|
203
389
|
};
|
204
390
|
"/transactionRequests/{ID}": {
|
205
|
-
/**
|
206
|
-
* Retrieve transaction request information
|
207
|
-
* @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request.
|
208
|
-
*/
|
209
|
-
get: operations["TransactionRequestsByID"];
|
210
|
-
/**
|
211
|
-
* Return transaction request information
|
212
|
-
* @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
|
213
|
-
*/
|
214
|
-
put: operations["TransactionRequestsByIDPut"];
|
215
391
|
parameters: {
|
392
|
+
query?: never;
|
216
393
|
header: {
|
394
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
217
395
|
"Content-Type": components["parameters"]["Content-Type"];
|
396
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
218
397
|
Date: components["parameters"]["Date"];
|
398
|
+
/** @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.
|
399
|
+
*
|
400
|
+
* **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`. */
|
219
401
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
402
|
+
/** @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`). */
|
220
403
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
404
|
+
/** @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. */
|
221
405
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
406
|
+
/** @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. */
|
222
407
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
408
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
223
409
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
410
|
+
/** @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). */
|
224
411
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
412
|
+
/** @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). */
|
225
413
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
226
414
|
};
|
227
415
|
path: {
|
416
|
+
/** @description The identifier value. */
|
228
417
|
ID: components["parameters"]["ID"];
|
229
418
|
};
|
419
|
+
cookie?: never;
|
230
420
|
};
|
421
|
+
/**
|
422
|
+
* Retrieve transaction request information
|
423
|
+
* @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request.
|
424
|
+
*/
|
425
|
+
get: operations["TransactionRequestsByID"];
|
426
|
+
/**
|
427
|
+
* Return transaction request information
|
428
|
+
* @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
|
429
|
+
*/
|
430
|
+
put: operations["TransactionRequestsByIDPut"];
|
431
|
+
post?: never;
|
432
|
+
delete?: never;
|
433
|
+
options?: never;
|
434
|
+
head?: never;
|
435
|
+
patch?: never;
|
436
|
+
trace?: never;
|
231
437
|
};
|
232
438
|
"/transactionRequests/{ID}/error": {
|
439
|
+
parameters: {
|
440
|
+
query?: never;
|
441
|
+
header?: never;
|
442
|
+
path?: never;
|
443
|
+
cookie?: never;
|
444
|
+
};
|
445
|
+
get?: never;
|
233
446
|
/**
|
234
447
|
* Return transaction request information error
|
235
448
|
* @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
|
236
449
|
*/
|
237
450
|
put: operations["TransactionRequestsErrorByID"];
|
451
|
+
post?: never;
|
452
|
+
delete?: never;
|
453
|
+
options?: never;
|
454
|
+
head?: never;
|
455
|
+
patch?: never;
|
456
|
+
trace?: never;
|
238
457
|
};
|
239
458
|
"/quotes": {
|
459
|
+
parameters: {
|
460
|
+
query?: never;
|
461
|
+
header?: never;
|
462
|
+
path?: never;
|
463
|
+
cookie?: never;
|
464
|
+
};
|
465
|
+
get?: never;
|
466
|
+
put?: never;
|
240
467
|
/**
|
241
468
|
* Calculate quote
|
242
469
|
* @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
|
243
470
|
*/
|
244
471
|
post: operations["Quotes"];
|
472
|
+
delete?: never;
|
473
|
+
options?: never;
|
474
|
+
head?: never;
|
475
|
+
patch?: never;
|
476
|
+
trace?: never;
|
245
477
|
};
|
246
478
|
"/quotes/{ID}": {
|
479
|
+
parameters: {
|
480
|
+
query?: never;
|
481
|
+
header: {
|
482
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
483
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
484
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
485
|
+
Date: components["parameters"]["Date"];
|
486
|
+
/** @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.
|
487
|
+
*
|
488
|
+
* **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`. */
|
489
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
490
|
+
/** @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`). */
|
491
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
492
|
+
/** @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
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
494
|
+
/** @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. */
|
495
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
496
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
497
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
498
|
+
/** @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). */
|
499
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
500
|
+
/** @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). */
|
501
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
502
|
+
};
|
503
|
+
path: {
|
504
|
+
/** @description The identifier value. */
|
505
|
+
ID: components["parameters"]["ID"];
|
506
|
+
};
|
507
|
+
cookie?: never;
|
508
|
+
};
|
247
509
|
/**
|
248
510
|
* Retrieve quote information
|
249
511
|
* @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote.
|
@@ -254,46 +516,79 @@ export interface paths {
|
|
254
516
|
* @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
|
255
517
|
*/
|
256
518
|
put: operations["QuotesByID1"];
|
519
|
+
post?: never;
|
520
|
+
delete?: never;
|
521
|
+
options?: never;
|
522
|
+
head?: never;
|
523
|
+
patch?: never;
|
524
|
+
trace?: never;
|
525
|
+
};
|
526
|
+
"/quotes/{ID}/error": {
|
257
527
|
parameters: {
|
528
|
+
query?: never;
|
529
|
+
header?: never;
|
530
|
+
path?: never;
|
531
|
+
cookie?: never;
|
532
|
+
};
|
533
|
+
get?: never;
|
534
|
+
/**
|
535
|
+
* Return quote information error
|
536
|
+
* @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
|
537
|
+
*/
|
538
|
+
put: operations["QuotesByIDAndError"];
|
539
|
+
post?: never;
|
540
|
+
delete?: never;
|
541
|
+
options?: never;
|
542
|
+
head?: never;
|
543
|
+
patch?: never;
|
544
|
+
trace?: never;
|
545
|
+
};
|
546
|
+
"/authorizations/{ID}": {
|
547
|
+
parameters: {
|
548
|
+
query?: never;
|
258
549
|
header: {
|
550
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
259
551
|
"Content-Type": components["parameters"]["Content-Type"];
|
552
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
260
553
|
Date: components["parameters"]["Date"];
|
554
|
+
/** @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.
|
555
|
+
*
|
556
|
+
* **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`. */
|
261
557
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
558
|
+
/** @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`). */
|
262
559
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
560
|
+
/** @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. */
|
263
561
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
562
|
+
/** @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. */
|
264
563
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
564
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
265
565
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
566
|
+
/** @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). */
|
266
567
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
568
|
+
/** @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). */
|
267
569
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
268
570
|
};
|
269
571
|
path: {
|
572
|
+
/** @description The identifier value. */
|
270
573
|
ID: components["parameters"]["ID"];
|
271
574
|
};
|
575
|
+
cookie?: never;
|
272
576
|
};
|
273
|
-
};
|
274
|
-
"/quotes/{ID}/error": {
|
275
|
-
/**
|
276
|
-
* Return quote information error
|
277
|
-
* @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
|
278
|
-
*/
|
279
|
-
put: operations["QuotesByIDAndError"];
|
280
|
-
};
|
281
|
-
"/authorizations/{ID}": {
|
282
577
|
/**
|
283
578
|
* Perform authorization
|
284
579
|
* @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
|
285
580
|
*
|
286
|
-
*
|
581
|
+
* - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
|
287
582
|
*
|
288
|
-
*
|
583
|
+
* - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected.
|
289
584
|
*
|
290
|
-
*
|
585
|
+
* - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`.
|
291
586
|
*
|
292
|
-
*
|
587
|
+
* - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`.
|
293
588
|
*
|
294
|
-
*
|
589
|
+
* The following is an example URI containing all the required key-value pairs in the query string*:*
|
295
590
|
*
|
296
|
-
*
|
591
|
+
* `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD`
|
297
592
|
*/
|
298
593
|
get: operations["AuthorizationsByIDGet"];
|
299
594
|
/**
|
@@ -301,195 +596,368 @@ export interface paths {
|
|
301
596
|
* @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request.
|
302
597
|
*/
|
303
598
|
put: operations["AuthorizationsByIDPut"];
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
311
|
-
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
312
|
-
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
313
|
-
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
314
|
-
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
315
|
-
};
|
316
|
-
path: {
|
317
|
-
ID: components["parameters"]["ID"];
|
318
|
-
};
|
319
|
-
};
|
599
|
+
post?: never;
|
600
|
+
delete?: never;
|
601
|
+
options?: never;
|
602
|
+
head?: never;
|
603
|
+
patch?: never;
|
604
|
+
trace?: never;
|
320
605
|
};
|
321
606
|
"/authorizations/{ID}/error": {
|
607
|
+
parameters: {
|
608
|
+
query?: never;
|
609
|
+
header?: never;
|
610
|
+
path?: never;
|
611
|
+
cookie?: never;
|
612
|
+
};
|
613
|
+
get?: never;
|
322
614
|
/**
|
323
615
|
* Return authorization error
|
324
616
|
* @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`.
|
325
617
|
*/
|
326
618
|
put: operations["AuthorizationsByIDAndError"];
|
619
|
+
post?: never;
|
620
|
+
delete?: never;
|
621
|
+
options?: never;
|
622
|
+
head?: never;
|
623
|
+
patch?: never;
|
624
|
+
trace?: never;
|
327
625
|
};
|
328
626
|
"/transfers": {
|
627
|
+
parameters: {
|
628
|
+
query?: never;
|
629
|
+
header?: never;
|
630
|
+
path?: never;
|
631
|
+
cookie?: never;
|
632
|
+
};
|
633
|
+
get?: never;
|
634
|
+
put?: never;
|
329
635
|
/**
|
330
636
|
* Perform transfer
|
331
637
|
* @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP.
|
332
638
|
*/
|
333
639
|
post: operations["transfers"];
|
640
|
+
delete?: never;
|
641
|
+
options?: never;
|
642
|
+
head?: never;
|
643
|
+
patch?: never;
|
644
|
+
trace?: never;
|
334
645
|
};
|
335
646
|
"/transfers/{ID}": {
|
336
|
-
/**
|
337
|
-
* Retrieve transfer information
|
338
|
-
* @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
339
|
-
*/
|
340
|
-
get: operations["TransfersByIDGet"];
|
341
|
-
/**
|
342
|
-
* Return transfer information
|
343
|
-
* @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request.
|
344
|
-
*/
|
345
|
-
put: operations["TransfersByIDPut"];
|
346
|
-
/**
|
347
|
-
* Return transfer information
|
348
|
-
* @description The HTTP request PATCH /transfers/<ID> is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The <ID> in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback.
|
349
|
-
*/
|
350
|
-
patch: operations["TransfersByIDPatch"];
|
351
647
|
parameters: {
|
648
|
+
query?: never;
|
352
649
|
header: {
|
650
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
353
651
|
"Content-Type": components["parameters"]["Content-Type"];
|
652
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
354
653
|
Date: components["parameters"]["Date"];
|
654
|
+
/** @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.
|
655
|
+
*
|
656
|
+
* **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`. */
|
355
657
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
658
|
+
/** @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`). */
|
356
659
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
660
|
+
/** @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. */
|
357
661
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
662
|
+
/** @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. */
|
358
663
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
664
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
359
665
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
666
|
+
/** @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). */
|
360
667
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
668
|
+
/** @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). */
|
361
669
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
362
670
|
};
|
363
671
|
path: {
|
672
|
+
/** @description The identifier value. */
|
364
673
|
ID: components["parameters"]["ID"];
|
365
674
|
};
|
675
|
+
cookie?: never;
|
366
676
|
};
|
677
|
+
/**
|
678
|
+
* Retrieve transfer information
|
679
|
+
* @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
680
|
+
*/
|
681
|
+
get: operations["TransfersByIDGet"];
|
682
|
+
/**
|
683
|
+
* Return transfer information
|
684
|
+
* @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request.
|
685
|
+
*/
|
686
|
+
put: operations["TransfersByIDPut"];
|
687
|
+
post?: never;
|
688
|
+
delete?: never;
|
689
|
+
options?: never;
|
690
|
+
head?: never;
|
691
|
+
/**
|
692
|
+
* Return transfer information
|
693
|
+
* @description The HTTP request PATCH /transfers/<ID> is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The <ID> in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback.
|
694
|
+
*/
|
695
|
+
patch: operations["TransfersByIDPatch"];
|
696
|
+
trace?: never;
|
367
697
|
};
|
368
698
|
"/transfers/{ID}/error": {
|
699
|
+
parameters: {
|
700
|
+
query?: never;
|
701
|
+
header?: never;
|
702
|
+
path?: never;
|
703
|
+
cookie?: never;
|
704
|
+
};
|
705
|
+
get?: never;
|
369
706
|
/**
|
370
707
|
* Return transfer information error
|
371
708
|
* @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`.
|
372
709
|
*/
|
373
710
|
put: operations["TransfersByIDAndError"];
|
711
|
+
post?: never;
|
712
|
+
delete?: never;
|
713
|
+
options?: never;
|
714
|
+
head?: never;
|
715
|
+
patch?: never;
|
716
|
+
trace?: never;
|
374
717
|
};
|
375
718
|
"/transactions/{ID}": {
|
376
|
-
/**
|
377
|
-
* Retrieve transaction information
|
378
|
-
* @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process).
|
379
|
-
*/
|
380
|
-
get: operations["TransactionsByID"];
|
381
|
-
/**
|
382
|
-
* Return transaction information
|
383
|
-
* @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
|
384
|
-
*/
|
385
|
-
put: operations["TransactionsByID1"];
|
386
719
|
parameters: {
|
720
|
+
query?: never;
|
387
721
|
header: {
|
722
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
388
723
|
"Content-Type": components["parameters"]["Content-Type"];
|
724
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
389
725
|
Date: components["parameters"]["Date"];
|
726
|
+
/** @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.
|
727
|
+
*
|
728
|
+
* **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`. */
|
390
729
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
730
|
+
/** @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`). */
|
391
731
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
732
|
+
/** @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. */
|
392
733
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
734
|
+
/** @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. */
|
393
735
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
736
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
394
737
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
738
|
+
/** @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). */
|
395
739
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
740
|
+
/** @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). */
|
396
741
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
397
742
|
};
|
398
743
|
path: {
|
744
|
+
/** @description The identifier value. */
|
399
745
|
ID: components["parameters"]["ID"];
|
400
746
|
};
|
747
|
+
cookie?: never;
|
401
748
|
};
|
749
|
+
/**
|
750
|
+
* Retrieve transaction information
|
751
|
+
* @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process).
|
752
|
+
*/
|
753
|
+
get: operations["TransactionsByID"];
|
754
|
+
/**
|
755
|
+
* Return transaction information
|
756
|
+
* @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
|
757
|
+
*/
|
758
|
+
put: operations["TransactionsByID1"];
|
759
|
+
post?: never;
|
760
|
+
delete?: never;
|
761
|
+
options?: never;
|
762
|
+
head?: never;
|
763
|
+
patch?: never;
|
764
|
+
trace?: never;
|
402
765
|
};
|
403
766
|
"/transactions/{ID}/error": {
|
767
|
+
parameters: {
|
768
|
+
query?: never;
|
769
|
+
header?: never;
|
770
|
+
path?: never;
|
771
|
+
cookie?: never;
|
772
|
+
};
|
773
|
+
get?: never;
|
404
774
|
/**
|
405
775
|
* Return transaction information error
|
406
776
|
* @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
|
407
777
|
*/
|
408
778
|
put: operations["TransactionsErrorByID"];
|
779
|
+
post?: never;
|
780
|
+
delete?: never;
|
781
|
+
options?: never;
|
782
|
+
head?: never;
|
783
|
+
patch?: never;
|
784
|
+
trace?: never;
|
409
785
|
};
|
410
786
|
"/bulkQuotes": {
|
787
|
+
parameters: {
|
788
|
+
query?: never;
|
789
|
+
header?: never;
|
790
|
+
path?: never;
|
791
|
+
cookie?: never;
|
792
|
+
};
|
793
|
+
get?: never;
|
794
|
+
put?: never;
|
411
795
|
/**
|
412
796
|
* Calculate bulk quote
|
413
797
|
* @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
|
414
798
|
*/
|
415
799
|
post: operations["BulkQuotes"];
|
800
|
+
delete?: never;
|
801
|
+
options?: never;
|
802
|
+
head?: never;
|
803
|
+
patch?: never;
|
804
|
+
trace?: never;
|
416
805
|
};
|
417
806
|
"/bulkQuotes/{ID}": {
|
418
|
-
/**
|
419
|
-
* Retrieve bulk quote information
|
420
|
-
* @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
|
421
|
-
*/
|
422
|
-
get: operations["BulkQuotesByID"];
|
423
|
-
/**
|
424
|
-
* Return bulk quote information
|
425
|
-
* @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
|
426
|
-
*/
|
427
|
-
put: operations["BulkQuotesByID1"];
|
428
807
|
parameters: {
|
808
|
+
query?: never;
|
429
809
|
header: {
|
810
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
430
811
|
"Content-Type": components["parameters"]["Content-Type"];
|
812
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
431
813
|
Date: components["parameters"]["Date"];
|
814
|
+
/** @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.
|
815
|
+
*
|
816
|
+
* **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`. */
|
432
817
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
818
|
+
/** @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`). */
|
433
819
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
820
|
+
/** @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. */
|
434
821
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
822
|
+
/** @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. */
|
435
823
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
824
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
436
825
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
826
|
+
/** @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). */
|
437
827
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
828
|
+
/** @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). */
|
438
829
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
439
830
|
};
|
440
831
|
path: {
|
832
|
+
/** @description The identifier value. */
|
441
833
|
ID: components["parameters"]["ID"];
|
442
834
|
};
|
835
|
+
cookie?: never;
|
443
836
|
};
|
837
|
+
/**
|
838
|
+
* Retrieve bulk quote information
|
839
|
+
* @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
|
840
|
+
*/
|
841
|
+
get: operations["BulkQuotesByID"];
|
842
|
+
/**
|
843
|
+
* Return bulk quote information
|
844
|
+
* @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
|
845
|
+
*/
|
846
|
+
put: operations["BulkQuotesByID1"];
|
847
|
+
post?: never;
|
848
|
+
delete?: never;
|
849
|
+
options?: never;
|
850
|
+
head?: never;
|
851
|
+
patch?: never;
|
852
|
+
trace?: never;
|
444
853
|
};
|
445
854
|
"/bulkQuotes/{ID}/error": {
|
855
|
+
parameters: {
|
856
|
+
query?: never;
|
857
|
+
header?: never;
|
858
|
+
path?: never;
|
859
|
+
cookie?: never;
|
860
|
+
};
|
861
|
+
get?: never;
|
446
862
|
/**
|
447
863
|
* Return bulk quote information error
|
448
864
|
* @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
|
449
865
|
*/
|
450
866
|
put: operations["BulkQuotesErrorByID"];
|
867
|
+
post?: never;
|
868
|
+
delete?: never;
|
869
|
+
options?: never;
|
870
|
+
head?: never;
|
871
|
+
patch?: never;
|
872
|
+
trace?: never;
|
451
873
|
};
|
452
874
|
"/bulkTransfers": {
|
875
|
+
parameters: {
|
876
|
+
query?: never;
|
877
|
+
header?: never;
|
878
|
+
path?: never;
|
879
|
+
cookie?: never;
|
880
|
+
};
|
881
|
+
get?: never;
|
882
|
+
put?: never;
|
453
883
|
/**
|
454
884
|
* Perform bulk transfer
|
455
885
|
* @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
|
456
886
|
*/
|
457
887
|
post: operations["BulkTransfers"];
|
888
|
+
delete?: never;
|
889
|
+
options?: never;
|
890
|
+
head?: never;
|
891
|
+
patch?: never;
|
892
|
+
trace?: never;
|
458
893
|
};
|
459
894
|
"/bulkTransfers/{ID}": {
|
460
|
-
/**
|
461
|
-
* Retrieve bulk transfer information
|
462
|
-
* @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
|
463
|
-
*/
|
464
|
-
get: operations["BulkTransferByID"];
|
465
|
-
/**
|
466
|
-
* Return bulk transfer information
|
467
|
-
* @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
|
468
|
-
*/
|
469
|
-
put: operations["BulkTransfersByIDPut"];
|
470
895
|
parameters: {
|
896
|
+
query?: never;
|
471
897
|
header: {
|
898
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
472
899
|
"Content-Type": components["parameters"]["Content-Type"];
|
900
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
473
901
|
Date: components["parameters"]["Date"];
|
902
|
+
/** @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.
|
903
|
+
*
|
904
|
+
* **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`. */
|
474
905
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
906
|
+
/** @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`). */
|
475
907
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
908
|
+
/** @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. */
|
476
909
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
910
|
+
/** @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. */
|
477
911
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
912
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
478
913
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
914
|
+
/** @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). */
|
479
915
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
916
|
+
/** @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). */
|
480
917
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
481
918
|
};
|
482
919
|
path: {
|
920
|
+
/** @description The identifier value. */
|
483
921
|
ID: components["parameters"]["ID"];
|
484
922
|
};
|
923
|
+
cookie?: never;
|
485
924
|
};
|
925
|
+
/**
|
926
|
+
* Retrieve bulk transfer information
|
927
|
+
* @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
|
928
|
+
*/
|
929
|
+
get: operations["BulkTransferByID"];
|
930
|
+
/**
|
931
|
+
* Return bulk transfer information
|
932
|
+
* @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
|
933
|
+
*/
|
934
|
+
put: operations["BulkTransfersByIDPut"];
|
935
|
+
post?: never;
|
936
|
+
delete?: never;
|
937
|
+
options?: never;
|
938
|
+
head?: never;
|
939
|
+
patch?: never;
|
940
|
+
trace?: never;
|
486
941
|
};
|
487
942
|
"/bulkTransfers/{ID}/error": {
|
943
|
+
parameters: {
|
944
|
+
query?: never;
|
945
|
+
header?: never;
|
946
|
+
path?: never;
|
947
|
+
cookie?: never;
|
948
|
+
};
|
949
|
+
get?: never;
|
488
950
|
/**
|
489
951
|
* Return bulk transfer information error
|
490
952
|
* @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
|
491
953
|
*/
|
492
954
|
put: operations["BulkTransfersErrorByID"];
|
955
|
+
post?: never;
|
956
|
+
delete?: never;
|
957
|
+
options?: never;
|
958
|
+
head?: never;
|
959
|
+
patch?: never;
|
960
|
+
trace?: never;
|
493
961
|
};
|
494
962
|
}
|
495
963
|
export type webhooks = Record<string, never>;
|
@@ -504,8 +972,8 @@ export interface components {
|
|
504
972
|
/**
|
505
973
|
* AmountType
|
506
974
|
* @description Below are the allowed values for the enumeration AmountType.
|
507
|
-
*
|
508
|
-
*
|
975
|
+
* - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
976
|
+
* - 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.
|
509
977
|
* @example RECEIVE
|
510
978
|
* @enum {string}
|
511
979
|
*/
|
@@ -521,9 +989,9 @@ export interface components {
|
|
521
989
|
/**
|
522
990
|
* AuthenticationType
|
523
991
|
* @description Below are the allowed values for the enumeration AuthenticationType.
|
524
|
-
*
|
525
|
-
*
|
526
|
-
*
|
992
|
+
* - OTP - One-time password generated by the Payer FSP.
|
993
|
+
* - QRCODE - QR code used as One Time Password.
|
994
|
+
* - U2F - U2F is a new addition isolated to Thirdparty stream.
|
527
995
|
* @example OTP
|
528
996
|
* @enum {string}
|
529
997
|
*/
|
@@ -536,9 +1004,9 @@ export interface components {
|
|
536
1004
|
/**
|
537
1005
|
* AuthorizationResponse
|
538
1006
|
* @description Below are the allowed values for the enumeration.
|
539
|
-
*
|
540
|
-
*
|
541
|
-
*
|
1007
|
+
* - ENTERED - Consumer entered the authentication value.
|
1008
|
+
* - REJECTED - Consumer rejected the transaction.
|
1009
|
+
* - RESEND - Consumer requested to resend the authentication value.
|
542
1010
|
* @example ENTERED
|
543
1011
|
* @enum {string}
|
544
1012
|
*/
|
@@ -587,12 +1055,12 @@ export interface components {
|
|
587
1055
|
/**
|
588
1056
|
* BulkTransactionState
|
589
1057
|
* @description Below are the allowed values for the enumeration.
|
590
|
-
*
|
591
|
-
*
|
592
|
-
*
|
593
|
-
*
|
594
|
-
*
|
595
|
-
*
|
1058
|
+
* - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
|
1059
|
+
* - PENDING - Payee FSP has validated the bulk transfer.
|
1060
|
+
* - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
|
1061
|
+
* - PROCESSING - Payee FSP has started to transfer fund to the Payees.
|
1062
|
+
* - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
|
1063
|
+
* - REJECTED - Payee FSP has rejected to process the bulk transfer.
|
596
1064
|
* @example RECEIVED
|
597
1065
|
* @enum {string}
|
598
1066
|
*/
|
@@ -851,9 +1319,9 @@ export interface components {
|
|
851
1319
|
* Name
|
852
1320
|
* @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.
|
853
1321
|
*
|
854
|
-
*
|
1322
|
+
* 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 ( ).
|
855
1323
|
*
|
856
|
-
*
|
1324
|
+
* **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.
|
857
1325
|
*/
|
858
1326
|
Name: string;
|
859
1327
|
/**
|
@@ -942,14 +1410,14 @@ export interface components {
|
|
942
1410
|
/**
|
943
1411
|
* PartyIdType
|
944
1412
|
* @description Below are the allowed values for the enumeration.
|
945
|
-
*
|
946
|
-
*
|
947
|
-
*
|
948
|
-
*
|
949
|
-
*
|
950
|
-
*
|
951
|
-
*
|
952
|
-
*
|
1413
|
+
* - MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.
|
1414
|
+
* - EMAIL - An email is used as reference to a participant. The format of the email should be according to the informational [RFC 3696](https://tools.ietf.org/html/rfc3696).
|
1415
|
+
* - PERSONAL_ID - A personal identifier is used as reference to a participant. Examples of personal identification are passport number, birth certificate number, and national registration number. The identifier number is added in the PartyIdentifier element. The personal identifier type is added in the PartySubIdOrType element.
|
1416
|
+
* - BUSINESS - A specific Business (for example, an organization or a company) is used as reference to a participant. The BUSINESS identifier can be in any format. To make a transaction connected to a specific username or bill number in a Business, the PartySubIdOrType element should be used.
|
1417
|
+
* - DEVICE - A specific device (for example, a POS or ATM) ID connected to a specific business or organization is used as reference to a Party. For referencing a specific device under a specific business or organization, use the PartySubIdOrType element.
|
1418
|
+
* - ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.
|
1419
|
+
* - IBAN - A bank account number or FSP account ID is used as reference to a participant. The IBAN identifier can consist of up to 34 alphanumeric characters and should be entered without whitespace.
|
1420
|
+
* - ALIAS An alias is used as reference to a participant. The alias should be created in the FSP as an alternative reference to an account owner. Another example of an alias is a username in the FSP system. The ALIAS identifier can be in any format. It is also possible to use the PartySubIdOrType element for identifying an account under an Alias defined by the PartyIdentifier.
|
953
1421
|
* @enum {string}
|
954
1422
|
*/
|
955
1423
|
PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
|
@@ -988,19 +1456,19 @@ export interface components {
|
|
988
1456
|
/**
|
989
1457
|
* PersonalIdentifierType
|
990
1458
|
* @description Below are the allowed values for the enumeration.
|
991
|
-
*
|
992
|
-
*
|
993
|
-
*
|
994
|
-
*
|
995
|
-
*
|
996
|
-
*
|
997
|
-
*
|
998
|
-
*
|
999
|
-
*
|
1000
|
-
*
|
1001
|
-
*
|
1002
|
-
*
|
1003
|
-
*
|
1459
|
+
* - PASSPORT - A passport number is used as reference to a Party.
|
1460
|
+
* - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party.
|
1461
|
+
* - DRIVING_LICENSE - A driving license is used as reference to a Party.
|
1462
|
+
* - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party.
|
1463
|
+
* - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party.
|
1464
|
+
* - EMPLOYER_ID - A tax identification number is used as reference to a Party.
|
1465
|
+
* - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
|
1466
|
+
* - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
|
1467
|
+
* - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
|
1468
|
+
* - HEALTH_CARD - A health card number is used as reference to a Party.
|
1469
|
+
* - VOTERS_ID - A voter’s identification number is used as reference to a Party.
|
1470
|
+
* - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
|
1471
|
+
* - OTHER_ID - Any other type of identification type number is used as reference to a Party.
|
1004
1472
|
* @enum {string}
|
1005
1473
|
*/
|
1006
1474
|
PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID";
|
@@ -1079,8 +1547,8 @@ export interface components {
|
|
1079
1547
|
/**
|
1080
1548
|
* TransactionInitiator
|
1081
1549
|
* @description Below are the allowed values for the enumeration.
|
1082
|
-
*
|
1083
|
-
*
|
1550
|
+
* - 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.
|
1551
|
+
* - 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.
|
1084
1552
|
* @example PAYEE
|
1085
1553
|
* @enum {string}
|
1086
1554
|
*/
|
@@ -1088,10 +1556,10 @@ export interface components {
|
|
1088
1556
|
/**
|
1089
1557
|
* TransactionInitiatorType
|
1090
1558
|
* @description Below are the allowed values for the enumeration.
|
1091
|
-
*
|
1092
|
-
*
|
1093
|
-
*
|
1094
|
-
*
|
1559
|
+
* - CONSUMER - Consumer is the initiator of the transaction.
|
1560
|
+
* - AGENT - Agent is the initiator of the transaction.
|
1561
|
+
* - BUSINESS - Business is the initiator of the transaction.
|
1562
|
+
* - DEVICE - Device is the initiator of the transaction.
|
1095
1563
|
* @example CONSUMER
|
1096
1564
|
* @enum {string}
|
1097
1565
|
*/
|
@@ -1099,10 +1567,10 @@ export interface components {
|
|
1099
1567
|
/**
|
1100
1568
|
* TransactionRequestState
|
1101
1569
|
* @description Below are the allowed values for the enumeration.
|
1102
|
-
*
|
1103
|
-
*
|
1104
|
-
*
|
1105
|
-
*
|
1570
|
+
* - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
|
1571
|
+
* - PENDING - Payer FSP has sent the transaction request to the Payer.
|
1572
|
+
* - ACCEPTED - Payer has approved the transaction.
|
1573
|
+
* - REJECTED - Payer has rejected the transaction.
|
1106
1574
|
* @example RECEIVED
|
1107
1575
|
* @enum {string}
|
1108
1576
|
*/
|
@@ -1135,11 +1603,11 @@ export interface components {
|
|
1135
1603
|
/**
|
1136
1604
|
* TransactionScenario
|
1137
1605
|
* @description Below are the allowed values for the enumeration.
|
1138
|
-
*
|
1139
|
-
*
|
1140
|
-
*
|
1141
|
-
*
|
1142
|
-
*
|
1606
|
+
* - 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.
|
1607
|
+
* - 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.
|
1608
|
+
* - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
1609
|
+
* - 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.
|
1610
|
+
* - REFUND - Used for performing a refund of transaction.
|
1143
1611
|
* @example DEPOSIT
|
1144
1612
|
* @enum {string}
|
1145
1613
|
*/
|
@@ -1147,10 +1615,10 @@ export interface components {
|
|
1147
1615
|
/**
|
1148
1616
|
* TransactionState
|
1149
1617
|
* @description Below are the allowed values for the enumeration.
|
1150
|
-
*
|
1151
|
-
*
|
1152
|
-
*
|
1153
|
-
*
|
1618
|
+
* - RECEIVED - Payee FSP has received the transaction from the Payer FSP.
|
1619
|
+
* - PENDING - Payee FSP has validated the transaction.
|
1620
|
+
* - COMPLETED - Payee FSP has successfully performed the transaction.
|
1621
|
+
* - REJECTED - Payee FSP has failed to perform the transaction.
|
1154
1622
|
* @example RECEIVED
|
1155
1623
|
* @enum {string}
|
1156
1624
|
*/
|
@@ -1186,10 +1654,10 @@ export interface components {
|
|
1186
1654
|
/**
|
1187
1655
|
* TransferState
|
1188
1656
|
* @description Below are the allowed values for the enumeration.
|
1189
|
-
*
|
1190
|
-
*
|
1191
|
-
*
|
1192
|
-
*
|
1657
|
+
* - RECEIVED - Next ledger has received the transfer.
|
1658
|
+
* - RESERVED - Next ledger has reserved the transfer.
|
1659
|
+
* - COMMITTED - Next ledger has successfully performed the transfer.
|
1660
|
+
* - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
|
1193
1661
|
* @example RESERVED
|
1194
1662
|
* @enum {string}
|
1195
1663
|
*/
|
@@ -1230,11 +1698,13 @@ export interface components {
|
|
1230
1698
|
/**
|
1231
1699
|
* U2FPIN
|
1232
1700
|
* @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1701
|
+
*
|
1233
1702
|
*/
|
1234
1703
|
U2FPIN: string;
|
1235
1704
|
/**
|
1236
1705
|
* U2FPinValue
|
1237
1706
|
* @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1707
|
+
*
|
1238
1708
|
*/
|
1239
1709
|
U2FPinValue: {
|
1240
1710
|
/** @description U2F challenge-response. */
|
@@ -1251,17 +1721,24 @@ export interface components {
|
|
1251
1721
|
responses: {
|
1252
1722
|
/** @description OK */
|
1253
1723
|
200: {
|
1254
|
-
|
1724
|
+
headers: {
|
1725
|
+
[name: string]: unknown;
|
1726
|
+
};
|
1727
|
+
content?: never;
|
1255
1728
|
};
|
1256
1729
|
/** @description Accepted */
|
1257
1730
|
202: {
|
1258
|
-
|
1731
|
+
headers: {
|
1732
|
+
[name: string]: unknown;
|
1733
|
+
};
|
1734
|
+
content?: never;
|
1259
1735
|
};
|
1260
1736
|
/** @description Bad Request */
|
1261
1737
|
400: {
|
1262
1738
|
headers: {
|
1263
1739
|
"Content-Length": components["headers"]["Content-Length"];
|
1264
1740
|
"Content-Type": components["headers"]["Content-Type"];
|
1741
|
+
[name: string]: unknown;
|
1265
1742
|
};
|
1266
1743
|
content: {
|
1267
1744
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1272,6 +1749,7 @@ export interface components {
|
|
1272
1749
|
headers: {
|
1273
1750
|
"Content-Length": components["headers"]["Content-Length"];
|
1274
1751
|
"Content-Type": components["headers"]["Content-Type"];
|
1752
|
+
[name: string]: unknown;
|
1275
1753
|
};
|
1276
1754
|
content: {
|
1277
1755
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1282,6 +1760,7 @@ export interface components {
|
|
1282
1760
|
headers: {
|
1283
1761
|
"Content-Length": components["headers"]["Content-Length"];
|
1284
1762
|
"Content-Type": components["headers"]["Content-Type"];
|
1763
|
+
[name: string]: unknown;
|
1285
1764
|
};
|
1286
1765
|
content: {
|
1287
1766
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1292,6 +1771,7 @@ export interface components {
|
|
1292
1771
|
headers: {
|
1293
1772
|
"Content-Length": components["headers"]["Content-Length"];
|
1294
1773
|
"Content-Type": components["headers"]["Content-Type"];
|
1774
|
+
[name: string]: unknown;
|
1295
1775
|
};
|
1296
1776
|
content: {
|
1297
1777
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1302,6 +1782,7 @@ export interface components {
|
|
1302
1782
|
headers: {
|
1303
1783
|
"Content-Length": components["headers"]["Content-Length"];
|
1304
1784
|
"Content-Type": components["headers"]["Content-Type"];
|
1785
|
+
[name: string]: unknown;
|
1305
1786
|
};
|
1306
1787
|
content: {
|
1307
1788
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1312,6 +1793,7 @@ export interface components {
|
|
1312
1793
|
headers: {
|
1313
1794
|
"Content-Length": components["headers"]["Content-Length"];
|
1314
1795
|
"Content-Type": components["headers"]["Content-Type"];
|
1796
|
+
[name: string]: unknown;
|
1315
1797
|
};
|
1316
1798
|
content: {
|
1317
1799
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1322,6 +1804,7 @@ export interface components {
|
|
1322
1804
|
headers: {
|
1323
1805
|
"Content-Length": components["headers"]["Content-Length"];
|
1324
1806
|
"Content-Type": components["headers"]["Content-Type"];
|
1807
|
+
[name: string]: unknown;
|
1325
1808
|
};
|
1326
1809
|
content: {
|
1327
1810
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1332,6 +1815,7 @@ export interface components {
|
|
1332
1815
|
headers: {
|
1333
1816
|
"Content-Length": components["headers"]["Content-Length"];
|
1334
1817
|
"Content-Type": components["headers"]["Content-Type"];
|
1818
|
+
[name: string]: unknown;
|
1335
1819
|
};
|
1336
1820
|
content: {
|
1337
1821
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1341,48 +1825,42 @@ export interface components {
|
|
1341
1825
|
parameters: {
|
1342
1826
|
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1343
1827
|
Accept: string;
|
1344
|
-
/**
|
1345
|
-
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1828
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1346
1829
|
*
|
1347
|
-
*
|
1348
|
-
|
1349
|
-
"Content-Length"?: number;
|
1830
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1831
|
+
"Content-Length": number;
|
1350
1832
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1351
1833
|
"Content-Type": string;
|
1352
1834
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
1353
1835
|
Date: string;
|
1354
1836
|
/** @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. */
|
1355
|
-
"FSPIOP-Destination"
|
1837
|
+
"FSPIOP-Destination": string;
|
1356
1838
|
/** @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. */
|
1357
|
-
"FSPIOP-Encryption"
|
1839
|
+
"FSPIOP-Encryption": string;
|
1358
1840
|
/** @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). */
|
1359
|
-
"FSPIOP-HTTP-Method"
|
1841
|
+
"FSPIOP-HTTP-Method": string;
|
1360
1842
|
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1361
|
-
"FSPIOP-Signature"
|
1843
|
+
"FSPIOP-Signature": string;
|
1362
1844
|
/** @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`). */
|
1363
1845
|
"FSPIOP-Source": string;
|
1364
1846
|
/** @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). */
|
1365
|
-
"FSPIOP-URI"
|
1847
|
+
"FSPIOP-URI": string;
|
1366
1848
|
/** @description The identifier value. */
|
1367
1849
|
ID: string;
|
1368
1850
|
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1369
1851
|
SubId: string;
|
1370
1852
|
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1371
1853
|
Type: string;
|
1372
|
-
/**
|
1373
|
-
* @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.
|
1854
|
+
/** @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.
|
1374
1855
|
*
|
1375
|
-
*
|
1376
|
-
|
1377
|
-
"X-Forwarded-For"?: string;
|
1856
|
+
* **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`. */
|
1857
|
+
"X-Forwarded-For": string;
|
1378
1858
|
};
|
1379
1859
|
requestBodies: never;
|
1380
1860
|
headers: {
|
1381
|
-
/**
|
1382
|
-
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1861
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1383
1862
|
*
|
1384
|
-
*
|
1385
|
-
*/
|
1863
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1386
1864
|
"Content-Length": number;
|
1387
1865
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1388
1866
|
"Content-Type": string;
|
@@ -1390,31 +1868,43 @@ export interface components {
|
|
1390
1868
|
pathItems: never;
|
1391
1869
|
}
|
1392
1870
|
export type $defs = Record<string, never>;
|
1393
|
-
export type external = Record<string, never>;
|
1394
1871
|
export interface operations {
|
1395
|
-
/**
|
1396
|
-
* Look up participant information
|
1397
|
-
* @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.
|
1398
|
-
*/
|
1399
1872
|
ParticipantsByTypeAndID: {
|
1400
1873
|
parameters: {
|
1874
|
+
query?: never;
|
1401
1875
|
header: {
|
1876
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1402
1877
|
"Content-Type": components["parameters"]["Content-Type"];
|
1878
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1403
1879
|
Date: components["parameters"]["Date"];
|
1880
|
+
/** @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.
|
1881
|
+
*
|
1882
|
+
* **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`. */
|
1404
1883
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1884
|
+
/** @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`). */
|
1405
1885
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1886
|
+
/** @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. */
|
1406
1887
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1888
|
+
/** @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. */
|
1407
1889
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1890
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1408
1891
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1892
|
+
/** @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). */
|
1409
1893
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1894
|
+
/** @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). */
|
1410
1895
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1896
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1411
1897
|
Accept: components["parameters"]["Accept"];
|
1412
1898
|
};
|
1413
1899
|
path: {
|
1900
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1414
1901
|
Type: components["parameters"]["Type"];
|
1902
|
+
/** @description The identifier value. */
|
1415
1903
|
ID: components["parameters"]["ID"];
|
1416
1904
|
};
|
1905
|
+
cookie?: never;
|
1417
1906
|
};
|
1907
|
+
requestBody?: never;
|
1418
1908
|
responses: {
|
1419
1909
|
202: components["responses"]["202"];
|
1420
1910
|
400: components["responses"]["400"];
|
@@ -1427,28 +1917,42 @@ export interface operations {
|
|
1427
1917
|
503: components["responses"]["503"];
|
1428
1918
|
};
|
1429
1919
|
};
|
1430
|
-
/**
|
1431
|
-
* Return participant information
|
1432
|
-
* @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.
|
1433
|
-
*/
|
1434
1920
|
ParticipantsByTypeAndID3: {
|
1435
1921
|
parameters: {
|
1922
|
+
query?: never;
|
1436
1923
|
header: {
|
1924
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1437
1925
|
"Content-Type": components["parameters"]["Content-Type"];
|
1926
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1438
1927
|
Date: components["parameters"]["Date"];
|
1928
|
+
/** @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.
|
1929
|
+
*
|
1930
|
+
* **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`. */
|
1439
1931
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1932
|
+
/** @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`). */
|
1440
1933
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1934
|
+
/** @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. */
|
1441
1935
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1936
|
+
/** @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. */
|
1442
1937
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1938
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1443
1939
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1940
|
+
/** @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). */
|
1444
1941
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1942
|
+
/** @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). */
|
1445
1943
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1944
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1945
|
+
*
|
1946
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1446
1947
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1447
1948
|
};
|
1448
1949
|
path: {
|
1950
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1449
1951
|
Type: components["parameters"]["Type"];
|
1952
|
+
/** @description The identifier value. */
|
1450
1953
|
ID: components["parameters"]["ID"];
|
1451
1954
|
};
|
1955
|
+
cookie?: never;
|
1452
1956
|
};
|
1453
1957
|
/** @description Participant information returned. */
|
1454
1958
|
requestBody: {
|
@@ -1468,29 +1972,44 @@ export interface operations {
|
|
1468
1972
|
503: components["responses"]["503"];
|
1469
1973
|
};
|
1470
1974
|
};
|
1471
|
-
/**
|
1472
|
-
* Create participant information
|
1473
|
-
* @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
|
1474
|
-
*/
|
1475
1975
|
ParticipantsByIDAndType: {
|
1476
1976
|
parameters: {
|
1977
|
+
query?: never;
|
1477
1978
|
header: {
|
1979
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1478
1980
|
"Content-Type": components["parameters"]["Content-Type"];
|
1981
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1479
1982
|
Date: components["parameters"]["Date"];
|
1983
|
+
/** @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.
|
1984
|
+
*
|
1985
|
+
* **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`. */
|
1480
1986
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1987
|
+
/** @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`). */
|
1481
1988
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1989
|
+
/** @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. */
|
1482
1990
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1991
|
+
/** @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. */
|
1483
1992
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1993
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1484
1994
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1995
|
+
/** @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). */
|
1485
1996
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1997
|
+
/** @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). */
|
1486
1998
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1999
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1487
2000
|
Accept: components["parameters"]["Accept"];
|
2001
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2002
|
+
*
|
2003
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1488
2004
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1489
2005
|
};
|
1490
2006
|
path: {
|
2007
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1491
2008
|
Type: components["parameters"]["Type"];
|
2009
|
+
/** @description The identifier value. */
|
1492
2010
|
ID: components["parameters"]["ID"];
|
1493
2011
|
};
|
2012
|
+
cookie?: never;
|
1494
2013
|
};
|
1495
2014
|
/** @description Participant information to be created. */
|
1496
2015
|
requestBody: {
|
@@ -1510,31 +2029,42 @@ export interface operations {
|
|
1510
2029
|
503: components["responses"]["503"];
|
1511
2030
|
};
|
1512
2031
|
};
|
1513
|
-
/**
|
1514
|
-
* Delete participant information
|
1515
|
-
* @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.
|
1516
|
-
*
|
1517
|
-
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
1518
|
-
*/
|
1519
2032
|
ParticipantsByTypeAndID2: {
|
1520
2033
|
parameters: {
|
2034
|
+
query?: never;
|
1521
2035
|
header: {
|
2036
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1522
2037
|
"Content-Type": components["parameters"]["Content-Type"];
|
2038
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1523
2039
|
Date: components["parameters"]["Date"];
|
2040
|
+
/** @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.
|
2041
|
+
*
|
2042
|
+
* **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`. */
|
1524
2043
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2044
|
+
/** @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`). */
|
1525
2045
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2046
|
+
/** @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. */
|
1526
2047
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2048
|
+
/** @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. */
|
1527
2049
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2050
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1528
2051
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2052
|
+
/** @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). */
|
1529
2053
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2054
|
+
/** @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). */
|
1530
2055
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2056
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1531
2057
|
Accept: components["parameters"]["Accept"];
|
1532
2058
|
};
|
1533
2059
|
path: {
|
2060
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1534
2061
|
Type: components["parameters"]["Type"];
|
2062
|
+
/** @description The identifier value. */
|
1535
2063
|
ID: components["parameters"]["ID"];
|
1536
2064
|
};
|
2065
|
+
cookie?: never;
|
1537
2066
|
};
|
2067
|
+
requestBody?: never;
|
1538
2068
|
responses: {
|
1539
2069
|
202: components["responses"]["202"];
|
1540
2070
|
400: components["responses"]["400"];
|
@@ -1547,28 +2077,42 @@ export interface operations {
|
|
1547
2077
|
503: components["responses"]["503"];
|
1548
2078
|
};
|
1549
2079
|
};
|
1550
|
-
/**
|
1551
|
-
* Return participant information error
|
1552
|
-
* @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.
|
1553
|
-
*/
|
1554
2080
|
ParticipantsErrorByTypeAndID: {
|
1555
2081
|
parameters: {
|
2082
|
+
query?: never;
|
1556
2083
|
header: {
|
2084
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2085
|
+
*
|
2086
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1557
2087
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2088
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1558
2089
|
"Content-Type": components["parameters"]["Content-Type"];
|
2090
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1559
2091
|
Date: components["parameters"]["Date"];
|
2092
|
+
/** @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.
|
2093
|
+
*
|
2094
|
+
* **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`. */
|
1560
2095
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2096
|
+
/** @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`). */
|
1561
2097
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2098
|
+
/** @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. */
|
1562
2099
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2100
|
+
/** @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. */
|
1563
2101
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2102
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1564
2103
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2104
|
+
/** @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). */
|
1565
2105
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2106
|
+
/** @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). */
|
1566
2107
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1567
2108
|
};
|
1568
2109
|
path: {
|
2110
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1569
2111
|
Type: components["parameters"]["Type"];
|
2112
|
+
/** @description The identifier value. */
|
1570
2113
|
ID: components["parameters"]["ID"];
|
1571
2114
|
};
|
2115
|
+
cookie?: never;
|
1572
2116
|
};
|
1573
2117
|
/** @description Details of the error returned. */
|
1574
2118
|
requestBody: {
|
@@ -1588,30 +2132,44 @@ export interface operations {
|
|
1588
2132
|
503: components["responses"]["503"];
|
1589
2133
|
};
|
1590
2134
|
};
|
1591
|
-
/**
|
1592
|
-
* Look up participant information
|
1593
|
-
* @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.
|
1594
|
-
*/
|
1595
2135
|
ParticipantsSubIdByTypeAndID: {
|
1596
2136
|
parameters: {
|
2137
|
+
query?: never;
|
1597
2138
|
header: {
|
2139
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1598
2140
|
"Content-Type": components["parameters"]["Content-Type"];
|
2141
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1599
2142
|
Date: components["parameters"]["Date"];
|
2143
|
+
/** @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.
|
2144
|
+
*
|
2145
|
+
* **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`. */
|
1600
2146
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2147
|
+
/** @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`). */
|
1601
2148
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2149
|
+
/** @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. */
|
1602
2150
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2151
|
+
/** @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. */
|
1603
2152
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2153
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1604
2154
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2155
|
+
/** @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). */
|
1605
2156
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2157
|
+
/** @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). */
|
1606
2158
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2159
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1607
2160
|
Accept: components["parameters"]["Accept"];
|
1608
2161
|
};
|
1609
2162
|
path: {
|
2163
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1610
2164
|
Type: components["parameters"]["Type"];
|
2165
|
+
/** @description The identifier value. */
|
1611
2166
|
ID: components["parameters"]["ID"];
|
2167
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1612
2168
|
SubId: components["parameters"]["SubId"];
|
1613
2169
|
};
|
2170
|
+
cookie?: never;
|
1614
2171
|
};
|
2172
|
+
requestBody?: never;
|
1615
2173
|
responses: {
|
1616
2174
|
202: components["responses"]["202"];
|
1617
2175
|
400: components["responses"]["400"];
|
@@ -1624,29 +2182,44 @@ export interface operations {
|
|
1624
2182
|
503: components["responses"]["503"];
|
1625
2183
|
};
|
1626
2184
|
};
|
1627
|
-
/**
|
1628
|
-
* Return participant information
|
1629
|
-
* @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.
|
1630
|
-
*/
|
1631
2185
|
ParticipantsSubIdByTypeAndID3: {
|
1632
2186
|
parameters: {
|
2187
|
+
query?: never;
|
1633
2188
|
header: {
|
2189
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1634
2190
|
"Content-Type": components["parameters"]["Content-Type"];
|
2191
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1635
2192
|
Date: components["parameters"]["Date"];
|
2193
|
+
/** @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.
|
2194
|
+
*
|
2195
|
+
* **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`. */
|
1636
2196
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2197
|
+
/** @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`). */
|
1637
2198
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2199
|
+
/** @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. */
|
1638
2200
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2201
|
+
/** @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. */
|
1639
2202
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2203
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1640
2204
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2205
|
+
/** @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). */
|
1641
2206
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2207
|
+
/** @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). */
|
1642
2208
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2209
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2210
|
+
*
|
2211
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1643
2212
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1644
2213
|
};
|
1645
2214
|
path: {
|
2215
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1646
2216
|
Type: components["parameters"]["Type"];
|
2217
|
+
/** @description The identifier value. */
|
1647
2218
|
ID: components["parameters"]["ID"];
|
2219
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1648
2220
|
SubId: components["parameters"]["SubId"];
|
1649
2221
|
};
|
2222
|
+
cookie?: never;
|
1650
2223
|
};
|
1651
2224
|
/** @description Participant information returned. */
|
1652
2225
|
requestBody: {
|
@@ -1666,30 +2239,46 @@ export interface operations {
|
|
1666
2239
|
503: components["responses"]["503"];
|
1667
2240
|
};
|
1668
2241
|
};
|
1669
|
-
/**
|
1670
|
-
* Create participant information
|
1671
|
-
* @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
|
1672
|
-
*/
|
1673
2242
|
ParticipantsSubIdByTypeAndIDPost: {
|
1674
2243
|
parameters: {
|
2244
|
+
query?: never;
|
1675
2245
|
header: {
|
2246
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1676
2247
|
"Content-Type": components["parameters"]["Content-Type"];
|
2248
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1677
2249
|
Date: components["parameters"]["Date"];
|
2250
|
+
/** @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.
|
2251
|
+
*
|
2252
|
+
* **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`. */
|
1678
2253
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2254
|
+
/** @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`). */
|
1679
2255
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2256
|
+
/** @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. */
|
1680
2257
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2258
|
+
/** @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. */
|
1681
2259
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2260
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1682
2261
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2262
|
+
/** @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). */
|
1683
2263
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2264
|
+
/** @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). */
|
1684
2265
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2266
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1685
2267
|
Accept: components["parameters"]["Accept"];
|
2268
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2269
|
+
*
|
2270
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1686
2271
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1687
2272
|
};
|
1688
2273
|
path: {
|
2274
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1689
2275
|
Type: components["parameters"]["Type"];
|
2276
|
+
/** @description The identifier value. */
|
1690
2277
|
ID: components["parameters"]["ID"];
|
2278
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1691
2279
|
SubId: components["parameters"]["SubId"];
|
1692
2280
|
};
|
2281
|
+
cookie?: never;
|
1693
2282
|
};
|
1694
2283
|
/** @description Participant information to be created. */
|
1695
2284
|
requestBody: {
|
@@ -1709,32 +2298,44 @@ export interface operations {
|
|
1709
2298
|
503: components["responses"]["503"];
|
1710
2299
|
};
|
1711
2300
|
};
|
1712
|
-
/**
|
1713
|
-
* Delete participant information
|
1714
|
-
* @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.
|
1715
|
-
*
|
1716
|
-
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
1717
|
-
*/
|
1718
2301
|
ParticipantsSubIdByTypeAndID2: {
|
1719
2302
|
parameters: {
|
2303
|
+
query?: never;
|
1720
2304
|
header: {
|
2305
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1721
2306
|
"Content-Type": components["parameters"]["Content-Type"];
|
2307
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1722
2308
|
Date: components["parameters"]["Date"];
|
2309
|
+
/** @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.
|
2310
|
+
*
|
2311
|
+
* **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`. */
|
1723
2312
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2313
|
+
/** @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`). */
|
1724
2314
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2315
|
+
/** @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. */
|
1725
2316
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2317
|
+
/** @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. */
|
1726
2318
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2319
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1727
2320
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2321
|
+
/** @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). */
|
1728
2322
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2323
|
+
/** @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). */
|
1729
2324
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2325
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1730
2326
|
Accept: components["parameters"]["Accept"];
|
1731
2327
|
};
|
1732
2328
|
path: {
|
2329
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1733
2330
|
Type: components["parameters"]["Type"];
|
2331
|
+
/** @description The identifier value. */
|
1734
2332
|
ID: components["parameters"]["ID"];
|
2333
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1735
2334
|
SubId: components["parameters"]["SubId"];
|
1736
2335
|
};
|
2336
|
+
cookie?: never;
|
1737
2337
|
};
|
2338
|
+
requestBody?: never;
|
1738
2339
|
responses: {
|
1739
2340
|
202: components["responses"]["202"];
|
1740
2341
|
400: components["responses"]["400"];
|
@@ -1747,29 +2348,44 @@ export interface operations {
|
|
1747
2348
|
503: components["responses"]["503"];
|
1748
2349
|
};
|
1749
2350
|
};
|
1750
|
-
/**
|
1751
|
-
* Return participant information error
|
1752
|
-
* @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.
|
1753
|
-
*/
|
1754
2351
|
ParticipantsSubIdErrorByTypeAndID: {
|
1755
2352
|
parameters: {
|
2353
|
+
query?: never;
|
1756
2354
|
header: {
|
2355
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2356
|
+
*
|
2357
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1757
2358
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2359
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1758
2360
|
"Content-Type": components["parameters"]["Content-Type"];
|
2361
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1759
2362
|
Date: components["parameters"]["Date"];
|
2363
|
+
/** @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.
|
2364
|
+
*
|
2365
|
+
* **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`. */
|
1760
2366
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2367
|
+
/** @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`). */
|
1761
2368
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2369
|
+
/** @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. */
|
1762
2370
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2371
|
+
/** @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. */
|
1763
2372
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2373
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1764
2374
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2375
|
+
/** @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). */
|
1765
2376
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2377
|
+
/** @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). */
|
1766
2378
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1767
2379
|
};
|
1768
2380
|
path: {
|
2381
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1769
2382
|
Type: components["parameters"]["Type"];
|
2383
|
+
/** @description The identifier value. */
|
1770
2384
|
ID: components["parameters"]["ID"];
|
2385
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1771
2386
|
SubId: components["parameters"]["SubId"];
|
1772
2387
|
};
|
2388
|
+
cookie?: never;
|
1773
2389
|
};
|
1774
2390
|
/** @description Details of the error returned. */
|
1775
2391
|
requestBody: {
|
@@ -1789,25 +2405,39 @@ export interface operations {
|
|
1789
2405
|
503: components["responses"]["503"];
|
1790
2406
|
};
|
1791
2407
|
};
|
1792
|
-
/**
|
1793
|
-
* Create bulk participant information
|
1794
|
-
* @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.
|
1795
|
-
*/
|
1796
2408
|
Participants1: {
|
1797
2409
|
parameters: {
|
2410
|
+
query?: never;
|
1798
2411
|
header: {
|
2412
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1799
2413
|
Accept: components["parameters"]["Accept"];
|
2414
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2415
|
+
*
|
2416
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1800
2417
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2418
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1801
2419
|
"Content-Type": components["parameters"]["Content-Type"];
|
2420
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1802
2421
|
Date: components["parameters"]["Date"];
|
2422
|
+
/** @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.
|
2423
|
+
*
|
2424
|
+
* **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`. */
|
1803
2425
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2426
|
+
/** @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`). */
|
1804
2427
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2428
|
+
/** @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. */
|
1805
2429
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2430
|
+
/** @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. */
|
1806
2431
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2432
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1807
2433
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2434
|
+
/** @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). */
|
1808
2435
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2436
|
+
/** @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). */
|
1809
2437
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1810
2438
|
};
|
2439
|
+
path?: never;
|
2440
|
+
cookie?: never;
|
1811
2441
|
};
|
1812
2442
|
/** @description Participant information to be created. */
|
1813
2443
|
requestBody: {
|
@@ -1827,27 +2457,40 @@ export interface operations {
|
|
1827
2457
|
503: components["responses"]["503"];
|
1828
2458
|
};
|
1829
2459
|
};
|
1830
|
-
/**
|
1831
|
-
* Return bulk participant information
|
1832
|
-
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
1833
|
-
*/
|
1834
2460
|
putParticipantsByID: {
|
1835
2461
|
parameters: {
|
2462
|
+
query?: never;
|
1836
2463
|
header: {
|
2464
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2465
|
+
*
|
2466
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1837
2467
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2468
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1838
2469
|
"Content-Type": components["parameters"]["Content-Type"];
|
2470
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1839
2471
|
Date: components["parameters"]["Date"];
|
2472
|
+
/** @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.
|
2473
|
+
*
|
2474
|
+
* **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`. */
|
1840
2475
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2476
|
+
/** @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`). */
|
1841
2477
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2478
|
+
/** @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. */
|
1842
2479
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2480
|
+
/** @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. */
|
1843
2481
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2482
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1844
2483
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2484
|
+
/** @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). */
|
1845
2485
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2486
|
+
/** @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). */
|
1846
2487
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1847
2488
|
};
|
1848
2489
|
path: {
|
2490
|
+
/** @description The identifier value. */
|
1849
2491
|
ID: components["parameters"]["ID"];
|
1850
2492
|
};
|
2493
|
+
cookie?: never;
|
1851
2494
|
};
|
1852
2495
|
/** @description Participant information returned. */
|
1853
2496
|
requestBody: {
|
@@ -1867,27 +2510,40 @@ export interface operations {
|
|
1867
2510
|
503: components["responses"]["503"];
|
1868
2511
|
};
|
1869
2512
|
};
|
1870
|
-
/**
|
1871
|
-
* Return bulk participant information error
|
1872
|
-
* @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.
|
1873
|
-
*/
|
1874
2513
|
ParticipantsByIDAndError: {
|
1875
2514
|
parameters: {
|
2515
|
+
query?: never;
|
1876
2516
|
header: {
|
2517
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2518
|
+
*
|
2519
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1877
2520
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2521
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1878
2522
|
"Content-Type": components["parameters"]["Content-Type"];
|
2523
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1879
2524
|
Date: components["parameters"]["Date"];
|
2525
|
+
/** @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.
|
2526
|
+
*
|
2527
|
+
* **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`. */
|
1880
2528
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2529
|
+
/** @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`). */
|
1881
2530
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2531
|
+
/** @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. */
|
1882
2532
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2533
|
+
/** @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. */
|
1883
2534
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2535
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1884
2536
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2537
|
+
/** @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). */
|
1885
2538
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2539
|
+
/** @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). */
|
1886
2540
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1887
2541
|
};
|
1888
2542
|
path: {
|
2543
|
+
/** @description The identifier value. */
|
1889
2544
|
ID: components["parameters"]["ID"];
|
1890
2545
|
};
|
2546
|
+
cookie?: never;
|
1891
2547
|
};
|
1892
2548
|
/** @description Details of the error returned. */
|
1893
2549
|
requestBody: {
|
@@ -1907,29 +2563,42 @@ export interface operations {
|
|
1907
2563
|
503: components["responses"]["503"];
|
1908
2564
|
};
|
1909
2565
|
};
|
1910
|
-
/**
|
1911
|
-
* Look up party information
|
1912
|
-
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
1913
|
-
*/
|
1914
2566
|
PartiesByTypeAndID: {
|
1915
2567
|
parameters: {
|
2568
|
+
query?: never;
|
1916
2569
|
header: {
|
2570
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1917
2571
|
"Content-Type": components["parameters"]["Content-Type"];
|
2572
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1918
2573
|
Date: components["parameters"]["Date"];
|
2574
|
+
/** @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.
|
2575
|
+
*
|
2576
|
+
* **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`. */
|
1919
2577
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2578
|
+
/** @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`). */
|
1920
2579
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2580
|
+
/** @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. */
|
1921
2581
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2582
|
+
/** @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. */
|
1922
2583
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2584
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1923
2585
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2586
|
+
/** @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). */
|
1924
2587
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2588
|
+
/** @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). */
|
1925
2589
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2590
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1926
2591
|
Accept: components["parameters"]["Accept"];
|
1927
2592
|
};
|
1928
2593
|
path: {
|
2594
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1929
2595
|
Type: components["parameters"]["Type"];
|
2596
|
+
/** @description The identifier value. */
|
1930
2597
|
ID: components["parameters"]["ID"];
|
1931
2598
|
};
|
2599
|
+
cookie?: never;
|
1932
2600
|
};
|
2601
|
+
requestBody?: never;
|
1933
2602
|
responses: {
|
1934
2603
|
202: components["responses"]["202"];
|
1935
2604
|
400: components["responses"]["400"];
|
@@ -1942,28 +2611,42 @@ export interface operations {
|
|
1942
2611
|
503: components["responses"]["503"];
|
1943
2612
|
};
|
1944
2613
|
};
|
1945
|
-
/**
|
1946
|
-
* Return party information
|
1947
|
-
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
1948
|
-
*/
|
1949
2614
|
PartiesByTypeAndID2: {
|
1950
2615
|
parameters: {
|
2616
|
+
query?: never;
|
1951
2617
|
header: {
|
2618
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1952
2619
|
"Content-Type": components["parameters"]["Content-Type"];
|
2620
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1953
2621
|
Date: components["parameters"]["Date"];
|
2622
|
+
/** @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.
|
2623
|
+
*
|
2624
|
+
* **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`. */
|
1954
2625
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2626
|
+
/** @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`). */
|
1955
2627
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2628
|
+
/** @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. */
|
1956
2629
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2630
|
+
/** @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. */
|
1957
2631
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2632
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1958
2633
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2634
|
+
/** @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). */
|
1959
2635
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2636
|
+
/** @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). */
|
1960
2637
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2638
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2639
|
+
*
|
2640
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1961
2641
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
1962
2642
|
};
|
1963
2643
|
path: {
|
2644
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1964
2645
|
Type: components["parameters"]["Type"];
|
2646
|
+
/** @description The identifier value. */
|
1965
2647
|
ID: components["parameters"]["ID"];
|
1966
2648
|
};
|
2649
|
+
cookie?: never;
|
1967
2650
|
};
|
1968
2651
|
/** @description Party information returned. */
|
1969
2652
|
requestBody: {
|
@@ -1983,28 +2666,42 @@ export interface operations {
|
|
1983
2666
|
503: components["responses"]["503"];
|
1984
2667
|
};
|
1985
2668
|
};
|
1986
|
-
/**
|
1987
|
-
* Return party information error
|
1988
|
-
* @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used.
|
1989
|
-
*/
|
1990
2669
|
PartiesErrorByTypeAndID: {
|
1991
2670
|
parameters: {
|
2671
|
+
query?: never;
|
1992
2672
|
header: {
|
2673
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2674
|
+
*
|
2675
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1993
2676
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2677
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1994
2678
|
"Content-Type": components["parameters"]["Content-Type"];
|
2679
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1995
2680
|
Date: components["parameters"]["Date"];
|
2681
|
+
/** @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.
|
2682
|
+
*
|
2683
|
+
* **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`. */
|
1996
2684
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2685
|
+
/** @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`). */
|
1997
2686
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2687
|
+
/** @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. */
|
1998
2688
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2689
|
+
/** @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. */
|
1999
2690
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2691
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2000
2692
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2693
|
+
/** @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). */
|
2001
2694
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2695
|
+
/** @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). */
|
2002
2696
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2003
2697
|
};
|
2004
2698
|
path: {
|
2699
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2005
2700
|
Type: components["parameters"]["Type"];
|
2701
|
+
/** @description The identifier value. */
|
2006
2702
|
ID: components["parameters"]["ID"];
|
2007
2703
|
};
|
2704
|
+
cookie?: never;
|
2008
2705
|
};
|
2009
2706
|
/** @description Details of the error returned. */
|
2010
2707
|
requestBody: {
|
@@ -2024,30 +2721,44 @@ export interface operations {
|
|
2024
2721
|
503: components["responses"]["503"];
|
2025
2722
|
};
|
2026
2723
|
};
|
2027
|
-
/**
|
2028
|
-
* Look up party information
|
2029
|
-
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
2030
|
-
*/
|
2031
2724
|
PartiesSubIdByTypeAndID: {
|
2032
2725
|
parameters: {
|
2726
|
+
query?: never;
|
2033
2727
|
header: {
|
2728
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2034
2729
|
"Content-Type": components["parameters"]["Content-Type"];
|
2730
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2035
2731
|
Date: components["parameters"]["Date"];
|
2732
|
+
/** @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.
|
2733
|
+
*
|
2734
|
+
* **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`. */
|
2036
2735
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2736
|
+
/** @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`). */
|
2037
2737
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2738
|
+
/** @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. */
|
2038
2739
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2740
|
+
/** @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. */
|
2039
2741
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2742
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2040
2743
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2744
|
+
/** @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). */
|
2041
2745
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2746
|
+
/** @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). */
|
2042
2747
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2748
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2043
2749
|
Accept: components["parameters"]["Accept"];
|
2044
2750
|
};
|
2045
2751
|
path: {
|
2752
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2046
2753
|
Type: components["parameters"]["Type"];
|
2754
|
+
/** @description The identifier value. */
|
2047
2755
|
ID: components["parameters"]["ID"];
|
2756
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2048
2757
|
SubId: components["parameters"]["SubId"];
|
2049
2758
|
};
|
2759
|
+
cookie?: never;
|
2050
2760
|
};
|
2761
|
+
requestBody?: never;
|
2051
2762
|
responses: {
|
2052
2763
|
202: components["responses"]["202"];
|
2053
2764
|
400: components["responses"]["400"];
|
@@ -2060,29 +2771,44 @@ export interface operations {
|
|
2060
2771
|
503: components["responses"]["503"];
|
2061
2772
|
};
|
2062
2773
|
};
|
2063
|
-
/**
|
2064
|
-
* Return party information
|
2065
|
-
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
2066
|
-
*/
|
2067
2774
|
PartiesSubIdByTypeAndIDPut: {
|
2068
2775
|
parameters: {
|
2776
|
+
query?: never;
|
2069
2777
|
header: {
|
2778
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2070
2779
|
"Content-Type": components["parameters"]["Content-Type"];
|
2780
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2071
2781
|
Date: components["parameters"]["Date"];
|
2782
|
+
/** @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.
|
2783
|
+
*
|
2784
|
+
* **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`. */
|
2072
2785
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2786
|
+
/** @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`). */
|
2073
2787
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2788
|
+
/** @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. */
|
2074
2789
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2790
|
+
/** @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. */
|
2075
2791
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2792
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2076
2793
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2794
|
+
/** @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). */
|
2077
2795
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2796
|
+
/** @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). */
|
2078
2797
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2798
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2799
|
+
*
|
2800
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2079
2801
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2080
2802
|
};
|
2081
2803
|
path: {
|
2804
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2082
2805
|
Type: components["parameters"]["Type"];
|
2806
|
+
/** @description The identifier value. */
|
2083
2807
|
ID: components["parameters"]["ID"];
|
2808
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2084
2809
|
SubId: components["parameters"]["SubId"];
|
2085
2810
|
};
|
2811
|
+
cookie?: never;
|
2086
2812
|
};
|
2087
2813
|
/** @description Party information returned. */
|
2088
2814
|
requestBody: {
|
@@ -2102,29 +2828,44 @@ export interface operations {
|
|
2102
2828
|
503: components["responses"]["503"];
|
2103
2829
|
};
|
2104
2830
|
};
|
2105
|
-
/**
|
2106
|
-
* Return party information error
|
2107
|
-
* @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used.
|
2108
|
-
*/
|
2109
2831
|
PartiesSubIdErrorByTypeAndID: {
|
2110
2832
|
parameters: {
|
2833
|
+
query?: never;
|
2111
2834
|
header: {
|
2835
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2836
|
+
*
|
2837
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2112
2838
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2839
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2113
2840
|
"Content-Type": components["parameters"]["Content-Type"];
|
2841
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2114
2842
|
Date: components["parameters"]["Date"];
|
2843
|
+
/** @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.
|
2844
|
+
*
|
2845
|
+
* **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`. */
|
2115
2846
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2847
|
+
/** @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`). */
|
2116
2848
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2849
|
+
/** @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. */
|
2117
2850
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2851
|
+
/** @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. */
|
2118
2852
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2853
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2119
2854
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2855
|
+
/** @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). */
|
2120
2856
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2857
|
+
/** @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). */
|
2121
2858
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2122
2859
|
};
|
2123
2860
|
path: {
|
2861
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2124
2862
|
Type: components["parameters"]["Type"];
|
2863
|
+
/** @description The identifier value. */
|
2125
2864
|
ID: components["parameters"]["ID"];
|
2865
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2126
2866
|
SubId: components["parameters"]["SubId"];
|
2127
2867
|
};
|
2868
|
+
cookie?: never;
|
2128
2869
|
};
|
2129
2870
|
/** @description Details of the error returned. */
|
2130
2871
|
requestBody: {
|
@@ -2144,25 +2885,39 @@ export interface operations {
|
|
2144
2885
|
503: components["responses"]["503"];
|
2145
2886
|
};
|
2146
2887
|
};
|
2147
|
-
/**
|
2148
|
-
* Perform transaction request
|
2149
|
-
* @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
|
2150
|
-
*/
|
2151
2888
|
TransactionRequests: {
|
2152
2889
|
parameters: {
|
2890
|
+
query?: never;
|
2153
2891
|
header: {
|
2892
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2154
2893
|
Accept: components["parameters"]["Accept"];
|
2894
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2895
|
+
*
|
2896
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2155
2897
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2898
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2156
2899
|
"Content-Type": components["parameters"]["Content-Type"];
|
2900
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2157
2901
|
Date: components["parameters"]["Date"];
|
2902
|
+
/** @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.
|
2903
|
+
*
|
2904
|
+
* **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`. */
|
2158
2905
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2906
|
+
/** @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`). */
|
2159
2907
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2908
|
+
/** @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. */
|
2160
2909
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2910
|
+
/** @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. */
|
2161
2911
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2912
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2162
2913
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2914
|
+
/** @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). */
|
2163
2915
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2916
|
+
/** @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). */
|
2164
2917
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2165
2918
|
};
|
2919
|
+
path?: never;
|
2920
|
+
cookie?: never;
|
2166
2921
|
};
|
2167
2922
|
/** @description Transaction request to be created. */
|
2168
2923
|
requestBody: {
|
@@ -2182,28 +2937,40 @@ export interface operations {
|
|
2182
2937
|
503: components["responses"]["503"];
|
2183
2938
|
};
|
2184
2939
|
};
|
2185
|
-
/**
|
2186
|
-
* Retrieve transaction request information
|
2187
|
-
* @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request.
|
2188
|
-
*/
|
2189
2940
|
TransactionRequestsByID: {
|
2190
2941
|
parameters: {
|
2942
|
+
query?: never;
|
2191
2943
|
header: {
|
2944
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2192
2945
|
"Content-Type": components["parameters"]["Content-Type"];
|
2946
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2193
2947
|
Date: components["parameters"]["Date"];
|
2948
|
+
/** @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.
|
2949
|
+
*
|
2950
|
+
* **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`. */
|
2194
2951
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2952
|
+
/** @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`). */
|
2195
2953
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2954
|
+
/** @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. */
|
2196
2955
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2956
|
+
/** @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. */
|
2197
2957
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2958
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2198
2959
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2960
|
+
/** @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). */
|
2199
2961
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2962
|
+
/** @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). */
|
2200
2963
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2964
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2201
2965
|
Accept: components["parameters"]["Accept"];
|
2202
2966
|
};
|
2203
2967
|
path: {
|
2968
|
+
/** @description The identifier value. */
|
2204
2969
|
ID: components["parameters"]["ID"];
|
2205
2970
|
};
|
2971
|
+
cookie?: never;
|
2206
2972
|
};
|
2973
|
+
requestBody?: never;
|
2207
2974
|
responses: {
|
2208
2975
|
202: components["responses"]["202"];
|
2209
2976
|
400: components["responses"]["400"];
|
@@ -2216,27 +2983,40 @@ export interface operations {
|
|
2216
2983
|
503: components["responses"]["503"];
|
2217
2984
|
};
|
2218
2985
|
};
|
2219
|
-
/**
|
2220
|
-
* Return transaction request information
|
2221
|
-
* @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
|
2222
|
-
*/
|
2223
2986
|
TransactionRequestsByIDPut: {
|
2224
2987
|
parameters: {
|
2988
|
+
query?: never;
|
2225
2989
|
header: {
|
2990
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2226
2991
|
"Content-Type": components["parameters"]["Content-Type"];
|
2992
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2227
2993
|
Date: components["parameters"]["Date"];
|
2994
|
+
/** @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.
|
2995
|
+
*
|
2996
|
+
* **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`. */
|
2228
2997
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2998
|
+
/** @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`). */
|
2229
2999
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3000
|
+
/** @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. */
|
2230
3001
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3002
|
+
/** @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. */
|
2231
3003
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3004
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2232
3005
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3006
|
+
/** @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). */
|
2233
3007
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3008
|
+
/** @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). */
|
2234
3009
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3010
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3011
|
+
*
|
3012
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2235
3013
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2236
3014
|
};
|
2237
3015
|
path: {
|
3016
|
+
/** @description The identifier value. */
|
2238
3017
|
ID: components["parameters"]["ID"];
|
2239
3018
|
};
|
3019
|
+
cookie?: never;
|
2240
3020
|
};
|
2241
3021
|
/** @description Transaction request information returned. */
|
2242
3022
|
requestBody: {
|
@@ -2256,27 +3036,40 @@ export interface operations {
|
|
2256
3036
|
503: components["responses"]["503"];
|
2257
3037
|
};
|
2258
3038
|
};
|
2259
|
-
/**
|
2260
|
-
* Return transaction request information error
|
2261
|
-
* @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
|
2262
|
-
*/
|
2263
3039
|
TransactionRequestsErrorByID: {
|
2264
3040
|
parameters: {
|
3041
|
+
query?: never;
|
2265
3042
|
header: {
|
3043
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3044
|
+
*
|
3045
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2266
3046
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3047
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2267
3048
|
"Content-Type": components["parameters"]["Content-Type"];
|
3049
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2268
3050
|
Date: components["parameters"]["Date"];
|
3051
|
+
/** @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.
|
3052
|
+
*
|
3053
|
+
* **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`. */
|
2269
3054
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3055
|
+
/** @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`). */
|
2270
3056
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3057
|
+
/** @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. */
|
2271
3058
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3059
|
+
/** @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. */
|
2272
3060
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3061
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2273
3062
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3063
|
+
/** @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). */
|
2274
3064
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3065
|
+
/** @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). */
|
2275
3066
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2276
3067
|
};
|
2277
3068
|
path: {
|
3069
|
+
/** @description The identifier value. */
|
2278
3070
|
ID: components["parameters"]["ID"];
|
2279
3071
|
};
|
3072
|
+
cookie?: never;
|
2280
3073
|
};
|
2281
3074
|
/** @description Details of the error returned. */
|
2282
3075
|
requestBody: {
|
@@ -2296,25 +3089,39 @@ export interface operations {
|
|
2296
3089
|
503: components["responses"]["503"];
|
2297
3090
|
};
|
2298
3091
|
};
|
2299
|
-
/**
|
2300
|
-
* Calculate quote
|
2301
|
-
* @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
|
2302
|
-
*/
|
2303
3092
|
Quotes: {
|
2304
3093
|
parameters: {
|
3094
|
+
query?: never;
|
2305
3095
|
header: {
|
3096
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2306
3097
|
Accept: components["parameters"]["Accept"];
|
3098
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3099
|
+
*
|
3100
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2307
3101
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3102
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2308
3103
|
"Content-Type": components["parameters"]["Content-Type"];
|
3104
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2309
3105
|
Date: components["parameters"]["Date"];
|
3106
|
+
/** @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.
|
3107
|
+
*
|
3108
|
+
* **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`. */
|
2310
3109
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3110
|
+
/** @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`). */
|
2311
3111
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3112
|
+
/** @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. */
|
2312
3113
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3114
|
+
/** @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. */
|
2313
3115
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3116
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2314
3117
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3118
|
+
/** @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). */
|
2315
3119
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3120
|
+
/** @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). */
|
2316
3121
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2317
3122
|
};
|
3123
|
+
path?: never;
|
3124
|
+
cookie?: never;
|
2318
3125
|
};
|
2319
3126
|
/** @description Details of the quote to be created. */
|
2320
3127
|
requestBody: {
|
@@ -2334,28 +3141,40 @@ export interface operations {
|
|
2334
3141
|
503: components["responses"]["503"];
|
2335
3142
|
};
|
2336
3143
|
};
|
2337
|
-
/**
|
2338
|
-
* Retrieve quote information
|
2339
|
-
* @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote.
|
2340
|
-
*/
|
2341
3144
|
QuotesByID: {
|
2342
3145
|
parameters: {
|
3146
|
+
query?: never;
|
2343
3147
|
header: {
|
3148
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2344
3149
|
"Content-Type": components["parameters"]["Content-Type"];
|
3150
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2345
3151
|
Date: components["parameters"]["Date"];
|
3152
|
+
/** @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.
|
3153
|
+
*
|
3154
|
+
* **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`. */
|
2346
3155
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3156
|
+
/** @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`). */
|
2347
3157
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3158
|
+
/** @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. */
|
2348
3159
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3160
|
+
/** @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. */
|
2349
3161
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3162
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2350
3163
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3164
|
+
/** @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). */
|
2351
3165
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3166
|
+
/** @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). */
|
2352
3167
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3168
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2353
3169
|
Accept: components["parameters"]["Accept"];
|
2354
3170
|
};
|
2355
3171
|
path: {
|
3172
|
+
/** @description The identifier value. */
|
2356
3173
|
ID: components["parameters"]["ID"];
|
2357
3174
|
};
|
3175
|
+
cookie?: never;
|
2358
3176
|
};
|
3177
|
+
requestBody?: never;
|
2359
3178
|
responses: {
|
2360
3179
|
202: components["responses"]["202"];
|
2361
3180
|
400: components["responses"]["400"];
|
@@ -2368,27 +3187,40 @@ export interface operations {
|
|
2368
3187
|
503: components["responses"]["503"];
|
2369
3188
|
};
|
2370
3189
|
};
|
2371
|
-
/**
|
2372
|
-
* Return quote information
|
2373
|
-
* @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
|
2374
|
-
*/
|
2375
3190
|
QuotesByID1: {
|
2376
3191
|
parameters: {
|
3192
|
+
query?: never;
|
2377
3193
|
header: {
|
3194
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2378
3195
|
"Content-Type": components["parameters"]["Content-Type"];
|
3196
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2379
3197
|
Date: components["parameters"]["Date"];
|
3198
|
+
/** @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.
|
3199
|
+
*
|
3200
|
+
* **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`. */
|
2380
3201
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3202
|
+
/** @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`). */
|
2381
3203
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3204
|
+
/** @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. */
|
2382
3205
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3206
|
+
/** @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. */
|
2383
3207
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3208
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2384
3209
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3210
|
+
/** @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). */
|
2385
3211
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3212
|
+
/** @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). */
|
2386
3213
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3214
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3215
|
+
*
|
3216
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2387
3217
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2388
3218
|
};
|
2389
3219
|
path: {
|
3220
|
+
/** @description The identifier value. */
|
2390
3221
|
ID: components["parameters"]["ID"];
|
2391
3222
|
};
|
3223
|
+
cookie?: never;
|
2392
3224
|
};
|
2393
3225
|
/** @description Quote information returned. */
|
2394
3226
|
requestBody: {
|
@@ -2408,27 +3240,40 @@ export interface operations {
|
|
2408
3240
|
503: components["responses"]["503"];
|
2409
3241
|
};
|
2410
3242
|
};
|
2411
|
-
/**
|
2412
|
-
* Return quote information error
|
2413
|
-
* @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
|
2414
|
-
*/
|
2415
3243
|
QuotesByIDAndError: {
|
2416
3244
|
parameters: {
|
3245
|
+
query?: never;
|
2417
3246
|
header: {
|
3247
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3248
|
+
*
|
3249
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2418
3250
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3251
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2419
3252
|
"Content-Type": components["parameters"]["Content-Type"];
|
3253
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2420
3254
|
Date: components["parameters"]["Date"];
|
3255
|
+
/** @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.
|
3256
|
+
*
|
3257
|
+
* **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`. */
|
2421
3258
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3259
|
+
/** @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`). */
|
2422
3260
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3261
|
+
/** @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. */
|
2423
3262
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3263
|
+
/** @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. */
|
2424
3264
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3265
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2425
3266
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3267
|
+
/** @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). */
|
2426
3268
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3269
|
+
/** @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). */
|
2427
3270
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2428
3271
|
};
|
2429
3272
|
path: {
|
3273
|
+
/** @description The identifier value. */
|
2430
3274
|
ID: components["parameters"]["ID"];
|
2431
3275
|
};
|
3276
|
+
cookie?: never;
|
2432
3277
|
};
|
2433
3278
|
/** @description Details of the error returned. */
|
2434
3279
|
requestBody: {
|
@@ -2448,40 +3293,40 @@ export interface operations {
|
|
2448
3293
|
503: components["responses"]["503"];
|
2449
3294
|
};
|
2450
3295
|
};
|
2451
|
-
/**
|
2452
|
-
* Perform authorization
|
2453
|
-
* @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
|
2454
|
-
*
|
2455
|
-
* - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
|
2456
|
-
*
|
2457
|
-
* - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected.
|
2458
|
-
*
|
2459
|
-
* - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`.
|
2460
|
-
*
|
2461
|
-
* - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`.
|
2462
|
-
*
|
2463
|
-
* The following is an example URI containing all the required key-value pairs in the query string*:*
|
2464
|
-
*
|
2465
|
-
* `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD`
|
2466
|
-
*/
|
2467
3296
|
AuthorizationsByIDGet: {
|
2468
3297
|
parameters: {
|
3298
|
+
query?: never;
|
2469
3299
|
header: {
|
3300
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2470
3301
|
"Content-Type": components["parameters"]["Content-Type"];
|
3302
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2471
3303
|
Date: components["parameters"]["Date"];
|
3304
|
+
/** @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.
|
3305
|
+
*
|
3306
|
+
* **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`. */
|
2472
3307
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3308
|
+
/** @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`). */
|
2473
3309
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3310
|
+
/** @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. */
|
2474
3311
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3312
|
+
/** @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. */
|
2475
3313
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3314
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2476
3315
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3316
|
+
/** @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). */
|
2477
3317
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3318
|
+
/** @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). */
|
2478
3319
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3320
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2479
3321
|
Accept: components["parameters"]["Accept"];
|
2480
3322
|
};
|
2481
3323
|
path: {
|
3324
|
+
/** @description The identifier value. */
|
2482
3325
|
ID: components["parameters"]["ID"];
|
2483
3326
|
};
|
3327
|
+
cookie?: never;
|
2484
3328
|
};
|
3329
|
+
requestBody?: never;
|
2485
3330
|
responses: {
|
2486
3331
|
202: components["responses"]["202"];
|
2487
3332
|
400: components["responses"]["400"];
|
@@ -2494,27 +3339,40 @@ export interface operations {
|
|
2494
3339
|
503: components["responses"]["503"];
|
2495
3340
|
};
|
2496
3341
|
};
|
2497
|
-
/**
|
2498
|
-
* Return authorization result
|
2499
|
-
* @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request.
|
2500
|
-
*/
|
2501
3342
|
AuthorizationsByIDPut: {
|
2502
3343
|
parameters: {
|
3344
|
+
query?: never;
|
2503
3345
|
header: {
|
3346
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2504
3347
|
"Content-Type": components["parameters"]["Content-Type"];
|
3348
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2505
3349
|
Date: components["parameters"]["Date"];
|
3350
|
+
/** @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.
|
3351
|
+
*
|
3352
|
+
* **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`. */
|
2506
3353
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3354
|
+
/** @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`). */
|
2507
3355
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3356
|
+
/** @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. */
|
2508
3357
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3358
|
+
/** @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. */
|
2509
3359
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3360
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2510
3361
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3362
|
+
/** @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). */
|
2511
3363
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3364
|
+
/** @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). */
|
2512
3365
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3366
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3367
|
+
*
|
3368
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2513
3369
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2514
3370
|
};
|
2515
3371
|
path: {
|
3372
|
+
/** @description The identifier value. */
|
2516
3373
|
ID: components["parameters"]["ID"];
|
2517
3374
|
};
|
3375
|
+
cookie?: never;
|
2518
3376
|
};
|
2519
3377
|
/** @description Authorization result returned. */
|
2520
3378
|
requestBody: {
|
@@ -2534,27 +3392,40 @@ export interface operations {
|
|
2534
3392
|
503: components["responses"]["503"];
|
2535
3393
|
};
|
2536
3394
|
};
|
2537
|
-
/**
|
2538
|
-
* Return authorization error
|
2539
|
-
* @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`.
|
2540
|
-
*/
|
2541
3395
|
AuthorizationsByIDAndError: {
|
2542
3396
|
parameters: {
|
3397
|
+
query?: never;
|
2543
3398
|
header: {
|
3399
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3400
|
+
*
|
3401
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2544
3402
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3403
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2545
3404
|
"Content-Type": components["parameters"]["Content-Type"];
|
3405
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2546
3406
|
Date: components["parameters"]["Date"];
|
3407
|
+
/** @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.
|
3408
|
+
*
|
3409
|
+
* **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`. */
|
2547
3410
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3411
|
+
/** @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`). */
|
2548
3412
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3413
|
+
/** @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. */
|
2549
3414
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3415
|
+
/** @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. */
|
2550
3416
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3417
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2551
3418
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3419
|
+
/** @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). */
|
2552
3420
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3421
|
+
/** @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). */
|
2553
3422
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2554
3423
|
};
|
2555
3424
|
path: {
|
3425
|
+
/** @description The identifier value. */
|
2556
3426
|
ID: components["parameters"]["ID"];
|
2557
3427
|
};
|
3428
|
+
cookie?: never;
|
2558
3429
|
};
|
2559
3430
|
/** @description Details of the error returned. */
|
2560
3431
|
requestBody: {
|
@@ -2574,25 +3445,39 @@ export interface operations {
|
|
2574
3445
|
503: components["responses"]["503"];
|
2575
3446
|
};
|
2576
3447
|
};
|
2577
|
-
/**
|
2578
|
-
* Perform transfer
|
2579
|
-
* @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP.
|
2580
|
-
*/
|
2581
3448
|
transfers: {
|
2582
3449
|
parameters: {
|
3450
|
+
query?: never;
|
2583
3451
|
header: {
|
3452
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2584
3453
|
Accept: components["parameters"]["Accept"];
|
3454
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3455
|
+
*
|
3456
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2585
3457
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3458
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2586
3459
|
"Content-Type": components["parameters"]["Content-Type"];
|
3460
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2587
3461
|
Date: components["parameters"]["Date"];
|
3462
|
+
/** @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.
|
3463
|
+
*
|
3464
|
+
* **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`. */
|
2588
3465
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3466
|
+
/** @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`). */
|
2589
3467
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3468
|
+
/** @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. */
|
2590
3469
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3470
|
+
/** @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. */
|
2591
3471
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3472
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2592
3473
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3474
|
+
/** @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). */
|
2593
3475
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3476
|
+
/** @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). */
|
2594
3477
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2595
3478
|
};
|
3479
|
+
path?: never;
|
3480
|
+
cookie?: never;
|
2596
3481
|
};
|
2597
3482
|
/** @description Details of the transfer to be created. */
|
2598
3483
|
requestBody: {
|
@@ -2612,28 +3497,40 @@ export interface operations {
|
|
2612
3497
|
503: components["responses"]["503"];
|
2613
3498
|
};
|
2614
3499
|
};
|
2615
|
-
/**
|
2616
|
-
* Retrieve transfer information
|
2617
|
-
* @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
2618
|
-
*/
|
2619
3500
|
TransfersByIDGet: {
|
2620
3501
|
parameters: {
|
3502
|
+
query?: never;
|
2621
3503
|
header: {
|
3504
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2622
3505
|
"Content-Type": components["parameters"]["Content-Type"];
|
3506
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2623
3507
|
Date: components["parameters"]["Date"];
|
3508
|
+
/** @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.
|
3509
|
+
*
|
3510
|
+
* **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`. */
|
2624
3511
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3512
|
+
/** @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`). */
|
2625
3513
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3514
|
+
/** @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. */
|
2626
3515
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3516
|
+
/** @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. */
|
2627
3517
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3518
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2628
3519
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3520
|
+
/** @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). */
|
2629
3521
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3522
|
+
/** @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). */
|
2630
3523
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3524
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2631
3525
|
Accept: components["parameters"]["Accept"];
|
2632
3526
|
};
|
2633
3527
|
path: {
|
3528
|
+
/** @description The identifier value. */
|
2634
3529
|
ID: components["parameters"]["ID"];
|
2635
3530
|
};
|
3531
|
+
cookie?: never;
|
2636
3532
|
};
|
3533
|
+
requestBody?: never;
|
2637
3534
|
responses: {
|
2638
3535
|
202: components["responses"]["202"];
|
2639
3536
|
400: components["responses"]["400"];
|
@@ -2646,27 +3543,40 @@ export interface operations {
|
|
2646
3543
|
503: components["responses"]["503"];
|
2647
3544
|
};
|
2648
3545
|
};
|
2649
|
-
/**
|
2650
|
-
* Return transfer information
|
2651
|
-
* @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request.
|
2652
|
-
*/
|
2653
3546
|
TransfersByIDPut: {
|
2654
3547
|
parameters: {
|
3548
|
+
query?: never;
|
2655
3549
|
header: {
|
3550
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2656
3551
|
"Content-Type": components["parameters"]["Content-Type"];
|
3552
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2657
3553
|
Date: components["parameters"]["Date"];
|
3554
|
+
/** @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.
|
3555
|
+
*
|
3556
|
+
* **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`. */
|
2658
3557
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3558
|
+
/** @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`). */
|
2659
3559
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3560
|
+
/** @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. */
|
2660
3561
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3562
|
+
/** @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. */
|
2661
3563
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3564
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2662
3565
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3566
|
+
/** @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). */
|
2663
3567
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3568
|
+
/** @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). */
|
2664
3569
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3570
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3571
|
+
*
|
3572
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2665
3573
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2666
3574
|
};
|
2667
3575
|
path: {
|
3576
|
+
/** @description The identifier value. */
|
2668
3577
|
ID: components["parameters"]["ID"];
|
2669
3578
|
};
|
3579
|
+
cookie?: never;
|
2670
3580
|
};
|
2671
3581
|
/** @description Transfer information returned. */
|
2672
3582
|
requestBody: {
|
@@ -2686,27 +3596,40 @@ export interface operations {
|
|
2686
3596
|
503: components["responses"]["503"];
|
2687
3597
|
};
|
2688
3598
|
};
|
2689
|
-
/**
|
2690
|
-
* Return transfer information
|
2691
|
-
* @description The HTTP request PATCH /transfers/<ID> is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The <ID> in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback.
|
2692
|
-
*/
|
2693
3599
|
TransfersByIDPatch: {
|
2694
3600
|
parameters: {
|
3601
|
+
query?: never;
|
2695
3602
|
header: {
|
3603
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2696
3604
|
"Content-Type": components["parameters"]["Content-Type"];
|
3605
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2697
3606
|
Date: components["parameters"]["Date"];
|
3607
|
+
/** @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.
|
3608
|
+
*
|
3609
|
+
* **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`. */
|
2698
3610
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3611
|
+
/** @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`). */
|
2699
3612
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3613
|
+
/** @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. */
|
2700
3614
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3615
|
+
/** @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. */
|
2701
3616
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3617
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2702
3618
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3619
|
+
/** @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). */
|
2703
3620
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3621
|
+
/** @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). */
|
2704
3622
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3623
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3624
|
+
*
|
3625
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2705
3626
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2706
3627
|
};
|
2707
3628
|
path: {
|
3629
|
+
/** @description The identifier value. */
|
2708
3630
|
ID: components["parameters"]["ID"];
|
2709
3631
|
};
|
3632
|
+
cookie?: never;
|
2710
3633
|
};
|
2711
3634
|
/** @description Transfer notification upon completion. */
|
2712
3635
|
requestBody: {
|
@@ -2726,27 +3649,40 @@ export interface operations {
|
|
2726
3649
|
503: components["responses"]["503"];
|
2727
3650
|
};
|
2728
3651
|
};
|
2729
|
-
/**
|
2730
|
-
* Return transfer information error
|
2731
|
-
* @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`.
|
2732
|
-
*/
|
2733
3652
|
TransfersByIDAndError: {
|
2734
3653
|
parameters: {
|
3654
|
+
query?: never;
|
2735
3655
|
header: {
|
3656
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3657
|
+
*
|
3658
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2736
3659
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3660
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2737
3661
|
"Content-Type": components["parameters"]["Content-Type"];
|
3662
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2738
3663
|
Date: components["parameters"]["Date"];
|
3664
|
+
/** @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.
|
3665
|
+
*
|
3666
|
+
* **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`. */
|
2739
3667
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3668
|
+
/** @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`). */
|
2740
3669
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3670
|
+
/** @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. */
|
2741
3671
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3672
|
+
/** @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. */
|
2742
3673
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3674
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2743
3675
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3676
|
+
/** @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). */
|
2744
3677
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3678
|
+
/** @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). */
|
2745
3679
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2746
3680
|
};
|
2747
3681
|
path: {
|
3682
|
+
/** @description The identifier value. */
|
2748
3683
|
ID: components["parameters"]["ID"];
|
2749
3684
|
};
|
3685
|
+
cookie?: never;
|
2750
3686
|
};
|
2751
3687
|
/** @description Details of the error returned. */
|
2752
3688
|
requestBody: {
|
@@ -2766,28 +3702,40 @@ export interface operations {
|
|
2766
3702
|
503: components["responses"]["503"];
|
2767
3703
|
};
|
2768
3704
|
};
|
2769
|
-
/**
|
2770
|
-
* Retrieve transaction information
|
2771
|
-
* @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process).
|
2772
|
-
*/
|
2773
3705
|
TransactionsByID: {
|
2774
3706
|
parameters: {
|
3707
|
+
query?: never;
|
2775
3708
|
header: {
|
3709
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2776
3710
|
"Content-Type": components["parameters"]["Content-Type"];
|
3711
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2777
3712
|
Date: components["parameters"]["Date"];
|
3713
|
+
/** @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.
|
3714
|
+
*
|
3715
|
+
* **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`. */
|
2778
3716
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3717
|
+
/** @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`). */
|
2779
3718
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3719
|
+
/** @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. */
|
2780
3720
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3721
|
+
/** @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. */
|
2781
3722
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3723
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2782
3724
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3725
|
+
/** @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). */
|
2783
3726
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3727
|
+
/** @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). */
|
2784
3728
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3729
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2785
3730
|
Accept: components["parameters"]["Accept"];
|
2786
3731
|
};
|
2787
3732
|
path: {
|
3733
|
+
/** @description The identifier value. */
|
2788
3734
|
ID: components["parameters"]["ID"];
|
2789
3735
|
};
|
3736
|
+
cookie?: never;
|
2790
3737
|
};
|
3738
|
+
requestBody?: never;
|
2791
3739
|
responses: {
|
2792
3740
|
202: components["responses"]["202"];
|
2793
3741
|
400: components["responses"]["400"];
|
@@ -2800,27 +3748,40 @@ export interface operations {
|
|
2800
3748
|
503: components["responses"]["503"];
|
2801
3749
|
};
|
2802
3750
|
};
|
2803
|
-
/**
|
2804
|
-
* Return transaction information
|
2805
|
-
* @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
|
2806
|
-
*/
|
2807
3751
|
TransactionsByID1: {
|
2808
3752
|
parameters: {
|
3753
|
+
query?: never;
|
2809
3754
|
header: {
|
3755
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2810
3756
|
"Content-Type": components["parameters"]["Content-Type"];
|
3757
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2811
3758
|
Date: components["parameters"]["Date"];
|
3759
|
+
/** @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.
|
3760
|
+
*
|
3761
|
+
* **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`. */
|
2812
3762
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3763
|
+
/** @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`). */
|
2813
3764
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3765
|
+
/** @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. */
|
2814
3766
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3767
|
+
/** @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. */
|
2815
3768
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3769
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2816
3770
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3771
|
+
/** @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). */
|
2817
3772
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3773
|
+
/** @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). */
|
2818
3774
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3775
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3776
|
+
*
|
3777
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2819
3778
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2820
3779
|
};
|
2821
3780
|
path: {
|
3781
|
+
/** @description The identifier value. */
|
2822
3782
|
ID: components["parameters"]["ID"];
|
2823
3783
|
};
|
3784
|
+
cookie?: never;
|
2824
3785
|
};
|
2825
3786
|
/** @description Transaction information returned. */
|
2826
3787
|
requestBody: {
|
@@ -2840,27 +3801,40 @@ export interface operations {
|
|
2840
3801
|
503: components["responses"]["503"];
|
2841
3802
|
};
|
2842
3803
|
};
|
2843
|
-
/**
|
2844
|
-
* Return transaction information error
|
2845
|
-
* @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
|
2846
|
-
*/
|
2847
3804
|
TransactionsErrorByID: {
|
2848
3805
|
parameters: {
|
3806
|
+
query?: never;
|
2849
3807
|
header: {
|
3808
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3809
|
+
*
|
3810
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2850
3811
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3812
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2851
3813
|
"Content-Type": components["parameters"]["Content-Type"];
|
3814
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2852
3815
|
Date: components["parameters"]["Date"];
|
3816
|
+
/** @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.
|
3817
|
+
*
|
3818
|
+
* **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`. */
|
2853
3819
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3820
|
+
/** @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`). */
|
2854
3821
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3822
|
+
/** @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. */
|
2855
3823
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3824
|
+
/** @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. */
|
2856
3825
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3826
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2857
3827
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3828
|
+
/** @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). */
|
2858
3829
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3830
|
+
/** @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). */
|
2859
3831
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2860
3832
|
};
|
2861
3833
|
path: {
|
3834
|
+
/** @description The identifier value. */
|
2862
3835
|
ID: components["parameters"]["ID"];
|
2863
3836
|
};
|
3837
|
+
cookie?: never;
|
2864
3838
|
};
|
2865
3839
|
/** @description Details of the error returned. */
|
2866
3840
|
requestBody: {
|
@@ -2880,25 +3854,39 @@ export interface operations {
|
|
2880
3854
|
503: components["responses"]["503"];
|
2881
3855
|
};
|
2882
3856
|
};
|
2883
|
-
/**
|
2884
|
-
* Calculate bulk quote
|
2885
|
-
* @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
|
2886
|
-
*/
|
2887
3857
|
BulkQuotes: {
|
2888
3858
|
parameters: {
|
3859
|
+
query?: never;
|
2889
3860
|
header: {
|
3861
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2890
3862
|
Accept: components["parameters"]["Accept"];
|
3863
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3864
|
+
*
|
3865
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2891
3866
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3867
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2892
3868
|
"Content-Type": components["parameters"]["Content-Type"];
|
3869
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2893
3870
|
Date: components["parameters"]["Date"];
|
3871
|
+
/** @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.
|
3872
|
+
*
|
3873
|
+
* **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`. */
|
2894
3874
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3875
|
+
/** @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`). */
|
2895
3876
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3877
|
+
/** @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. */
|
2896
3878
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3879
|
+
/** @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. */
|
2897
3880
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3881
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2898
3882
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3883
|
+
/** @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). */
|
2899
3884
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3885
|
+
/** @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). */
|
2900
3886
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2901
3887
|
};
|
3888
|
+
path?: never;
|
3889
|
+
cookie?: never;
|
2902
3890
|
};
|
2903
3891
|
/** @description Details of the bulk quote to be created. */
|
2904
3892
|
requestBody: {
|
@@ -2918,28 +3906,40 @@ export interface operations {
|
|
2918
3906
|
503: components["responses"]["503"];
|
2919
3907
|
};
|
2920
3908
|
};
|
2921
|
-
/**
|
2922
|
-
* Retrieve bulk quote information
|
2923
|
-
* @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
|
2924
|
-
*/
|
2925
3909
|
BulkQuotesByID: {
|
2926
3910
|
parameters: {
|
3911
|
+
query?: never;
|
2927
3912
|
header: {
|
3913
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2928
3914
|
"Content-Type": components["parameters"]["Content-Type"];
|
3915
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2929
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`. */
|
2930
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`). */
|
2931
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. */
|
2932
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. */
|
2933
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. */
|
2934
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). */
|
2935
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). */
|
2936
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. */
|
2937
3934
|
Accept: components["parameters"]["Accept"];
|
2938
3935
|
};
|
2939
3936
|
path: {
|
3937
|
+
/** @description The identifier value. */
|
2940
3938
|
ID: components["parameters"]["ID"];
|
2941
3939
|
};
|
3940
|
+
cookie?: never;
|
2942
3941
|
};
|
3942
|
+
requestBody?: never;
|
2943
3943
|
responses: {
|
2944
3944
|
202: components["responses"]["202"];
|
2945
3945
|
400: components["responses"]["400"];
|
@@ -2952,27 +3952,40 @@ export interface operations {
|
|
2952
3952
|
503: components["responses"]["503"];
|
2953
3953
|
};
|
2954
3954
|
};
|
2955
|
-
/**
|
2956
|
-
* Return bulk quote information
|
2957
|
-
* @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
|
2958
|
-
*/
|
2959
3955
|
BulkQuotesByID1: {
|
2960
3956
|
parameters: {
|
3957
|
+
query?: never;
|
2961
3958
|
header: {
|
3959
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2962
3960
|
"Content-Type": components["parameters"]["Content-Type"];
|
3961
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2963
3962
|
Date: components["parameters"]["Date"];
|
3963
|
+
/** @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.
|
3964
|
+
*
|
3965
|
+
* **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`. */
|
2964
3966
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3967
|
+
/** @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`). */
|
2965
3968
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3969
|
+
/** @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. */
|
2966
3970
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3971
|
+
/** @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. */
|
2967
3972
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3973
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2968
3974
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3975
|
+
/** @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). */
|
2969
3976
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3977
|
+
/** @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). */
|
2970
3978
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3979
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3980
|
+
*
|
3981
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2971
3982
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2972
3983
|
};
|
2973
3984
|
path: {
|
3985
|
+
/** @description The identifier value. */
|
2974
3986
|
ID: components["parameters"]["ID"];
|
2975
3987
|
};
|
3988
|
+
cookie?: never;
|
2976
3989
|
};
|
2977
3990
|
/** @description Bulk quote information returned. */
|
2978
3991
|
requestBody: {
|
@@ -2992,27 +4005,40 @@ export interface operations {
|
|
2992
4005
|
503: components["responses"]["503"];
|
2993
4006
|
};
|
2994
4007
|
};
|
2995
|
-
/**
|
2996
|
-
* Return bulk quote information error
|
2997
|
-
* @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
|
2998
|
-
*/
|
2999
4008
|
BulkQuotesErrorByID: {
|
3000
4009
|
parameters: {
|
4010
|
+
query?: never;
|
3001
4011
|
header: {
|
4012
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4013
|
+
*
|
4014
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3002
4015
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4016
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3003
4017
|
"Content-Type": components["parameters"]["Content-Type"];
|
4018
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3004
4019
|
Date: components["parameters"]["Date"];
|
4020
|
+
/** @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.
|
4021
|
+
*
|
4022
|
+
* **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`. */
|
3005
4023
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4024
|
+
/** @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`). */
|
3006
4025
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4026
|
+
/** @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. */
|
3007
4027
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4028
|
+
/** @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. */
|
3008
4029
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4030
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3009
4031
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4032
|
+
/** @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). */
|
3010
4033
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4034
|
+
/** @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). */
|
3011
4035
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3012
4036
|
};
|
3013
4037
|
path: {
|
4038
|
+
/** @description The identifier value. */
|
3014
4039
|
ID: components["parameters"]["ID"];
|
3015
4040
|
};
|
4041
|
+
cookie?: never;
|
3016
4042
|
};
|
3017
4043
|
/** @description Details of the error returned. */
|
3018
4044
|
requestBody: {
|
@@ -3032,25 +4058,39 @@ export interface operations {
|
|
3032
4058
|
503: components["responses"]["503"];
|
3033
4059
|
};
|
3034
4060
|
};
|
3035
|
-
/**
|
3036
|
-
* Perform bulk transfer
|
3037
|
-
* @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
|
3038
|
-
*/
|
3039
4061
|
BulkTransfers: {
|
3040
4062
|
parameters: {
|
4063
|
+
query?: never;
|
3041
4064
|
header: {
|
4065
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3042
4066
|
Accept: components["parameters"]["Accept"];
|
4067
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4068
|
+
*
|
4069
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3043
4070
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4071
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3044
4072
|
"Content-Type": components["parameters"]["Content-Type"];
|
4073
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3045
4074
|
Date: components["parameters"]["Date"];
|
4075
|
+
/** @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.
|
4076
|
+
*
|
4077
|
+
* **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`. */
|
3046
4078
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4079
|
+
/** @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`). */
|
3047
4080
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4081
|
+
/** @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. */
|
3048
4082
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4083
|
+
/** @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. */
|
3049
4084
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4085
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3050
4086
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4087
|
+
/** @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). */
|
3051
4088
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4089
|
+
/** @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). */
|
3052
4090
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3053
4091
|
};
|
4092
|
+
path?: never;
|
4093
|
+
cookie?: never;
|
3054
4094
|
};
|
3055
4095
|
/** @description Details of the bulk transfer to be created. */
|
3056
4096
|
requestBody: {
|
@@ -3070,28 +4110,40 @@ export interface operations {
|
|
3070
4110
|
503: components["responses"]["503"];
|
3071
4111
|
};
|
3072
4112
|
};
|
3073
|
-
/**
|
3074
|
-
* Retrieve bulk transfer information
|
3075
|
-
* @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
|
3076
|
-
*/
|
3077
4113
|
BulkTransferByID: {
|
3078
4114
|
parameters: {
|
4115
|
+
query?: never;
|
3079
4116
|
header: {
|
4117
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3080
4118
|
"Content-Type": components["parameters"]["Content-Type"];
|
4119
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3081
4120
|
Date: components["parameters"]["Date"];
|
4121
|
+
/** @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.
|
4122
|
+
*
|
4123
|
+
* **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`. */
|
3082
4124
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4125
|
+
/** @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`). */
|
3083
4126
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4127
|
+
/** @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. */
|
3084
4128
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4129
|
+
/** @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. */
|
3085
4130
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4131
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3086
4132
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4133
|
+
/** @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). */
|
3087
4134
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4135
|
+
/** @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). */
|
3088
4136
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4137
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3089
4138
|
Accept: components["parameters"]["Accept"];
|
3090
4139
|
};
|
3091
4140
|
path: {
|
4141
|
+
/** @description The identifier value. */
|
3092
4142
|
ID: components["parameters"]["ID"];
|
3093
4143
|
};
|
4144
|
+
cookie?: never;
|
3094
4145
|
};
|
4146
|
+
requestBody?: never;
|
3095
4147
|
responses: {
|
3096
4148
|
202: components["responses"]["202"];
|
3097
4149
|
400: components["responses"]["400"];
|
@@ -3104,27 +4156,40 @@ export interface operations {
|
|
3104
4156
|
503: components["responses"]["503"];
|
3105
4157
|
};
|
3106
4158
|
};
|
3107
|
-
/**
|
3108
|
-
* Return bulk transfer information
|
3109
|
-
* @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
|
3110
|
-
*/
|
3111
4159
|
BulkTransfersByIDPut: {
|
3112
4160
|
parameters: {
|
4161
|
+
query?: never;
|
3113
4162
|
header: {
|
4163
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3114
4164
|
"Content-Type": components["parameters"]["Content-Type"];
|
4165
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3115
4166
|
Date: components["parameters"]["Date"];
|
4167
|
+
/** @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.
|
4168
|
+
*
|
4169
|
+
* **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`. */
|
3116
4170
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4171
|
+
/** @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`). */
|
3117
4172
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4173
|
+
/** @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. */
|
3118
4174
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4175
|
+
/** @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. */
|
3119
4176
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4177
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3120
4178
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4179
|
+
/** @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). */
|
3121
4180
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4181
|
+
/** @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). */
|
3122
4182
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4183
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4184
|
+
*
|
4185
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3123
4186
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3124
4187
|
};
|
3125
4188
|
path: {
|
4189
|
+
/** @description The identifier value. */
|
3126
4190
|
ID: components["parameters"]["ID"];
|
3127
4191
|
};
|
4192
|
+
cookie?: never;
|
3128
4193
|
};
|
3129
4194
|
/** @description Bulk transfer information returned. */
|
3130
4195
|
requestBody: {
|
@@ -3144,27 +4209,40 @@ export interface operations {
|
|
3144
4209
|
503: components["responses"]["503"];
|
3145
4210
|
};
|
3146
4211
|
};
|
3147
|
-
/**
|
3148
|
-
* Return bulk transfer information error
|
3149
|
-
* @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
|
3150
|
-
*/
|
3151
4212
|
BulkTransfersErrorByID: {
|
3152
4213
|
parameters: {
|
4214
|
+
query?: never;
|
3153
4215
|
header: {
|
4216
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4217
|
+
*
|
4218
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3154
4219
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4220
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3155
4221
|
"Content-Type": components["parameters"]["Content-Type"];
|
4222
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3156
4223
|
Date: components["parameters"]["Date"];
|
4224
|
+
/** @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.
|
4225
|
+
*
|
4226
|
+
* **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`. */
|
3157
4227
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4228
|
+
/** @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`). */
|
3158
4229
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4230
|
+
/** @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. */
|
3159
4231
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4232
|
+
/** @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. */
|
3160
4233
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4234
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3161
4235
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4236
|
+
/** @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). */
|
3162
4237
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4238
|
+
/** @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). */
|
3163
4239
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3164
4240
|
};
|
3165
4241
|
path: {
|
4242
|
+
/** @description The identifier value. */
|
3166
4243
|
ID: components["parameters"]["ID"];
|
3167
4244
|
};
|
4245
|
+
cookie?: never;
|
3168
4246
|
};
|
3169
4247
|
/** @description Details of the error returned. */
|
3170
4248
|
requestBody: {
|