@mojaloop/api-snippets 17.6.0-snapshot.2 → 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 +7 -0
- package/audit-ci.jsonc +2 -2
- 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 +1 -1
- package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +7 -7
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1 -1
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +1 -1
- package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml +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 +14 -14
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +384 -74
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +55 -55
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +543 -109
- package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +66 -66
- package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +503 -139
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +72 -72
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +694 -184
- package/lib/thirdparty/openapi.d.ts +1639 -612
- package/package.json +30 -27
- package/sdk-bulk.yaml +1 -1
- package/sdk-scheme-adapter/v2_0_0/components/schemas/CorrelationId.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +6 -6
- package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml +1 -1
@@ -4,10 +4,55 @@
|
|
4
4
|
*/
|
5
5
|
export interface paths {
|
6
6
|
"/interface": {
|
7
|
+
parameters: {
|
8
|
+
query?: never;
|
9
|
+
header?: never;
|
10
|
+
path?: never;
|
11
|
+
cookie?: never;
|
12
|
+
};
|
13
|
+
get?: never;
|
14
|
+
put?: never;
|
7
15
|
/** @description Essential path to include schema components that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
8
16
|
post: operations["Interface"];
|
17
|
+
delete?: never;
|
18
|
+
options?: never;
|
19
|
+
head?: never;
|
20
|
+
patch?: never;
|
21
|
+
trace?: never;
|
9
22
|
};
|
10
23
|
"/participants/{Type}/{ID}": {
|
24
|
+
parameters: {
|
25
|
+
query?: never;
|
26
|
+
header: {
|
27
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
28
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
29
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
30
|
+
Date: components["parameters"]["Date"];
|
31
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
32
|
+
*
|
33
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
34
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
35
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
36
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
37
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
38
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
39
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
40
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
41
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
42
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
43
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
44
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
45
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
46
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
47
|
+
};
|
48
|
+
path: {
|
49
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
50
|
+
Type: components["parameters"]["Type"];
|
51
|
+
/** @description The identifier value. */
|
52
|
+
ID: components["parameters"]["ID"];
|
53
|
+
};
|
54
|
+
cookie?: never;
|
55
|
+
};
|
11
56
|
/**
|
12
57
|
* Look up participant information
|
13
58
|
* @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.
|
@@ -27,35 +72,69 @@ export interface paths {
|
|
27
72
|
* Delete participant information
|
28
73
|
* @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.
|
29
74
|
*
|
30
|
-
*
|
75
|
+
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
31
76
|
*/
|
32
77
|
delete: operations["ParticipantsByTypeAndID2"];
|
78
|
+
options?: never;
|
79
|
+
head?: never;
|
80
|
+
patch?: never;
|
81
|
+
trace?: never;
|
82
|
+
};
|
83
|
+
"/participants/{Type}/{ID}/error": {
|
33
84
|
parameters: {
|
85
|
+
query?: never;
|
86
|
+
header?: never;
|
87
|
+
path?: never;
|
88
|
+
cookie?: never;
|
89
|
+
};
|
90
|
+
get?: never;
|
91
|
+
/**
|
92
|
+
* Return participant information error
|
93
|
+
* @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.
|
94
|
+
*/
|
95
|
+
put: operations["ParticipantsErrorByTypeAndID"];
|
96
|
+
post?: never;
|
97
|
+
delete?: never;
|
98
|
+
options?: never;
|
99
|
+
head?: never;
|
100
|
+
patch?: never;
|
101
|
+
trace?: never;
|
102
|
+
};
|
103
|
+
"/participants/{Type}/{ID}/{SubId}": {
|
104
|
+
parameters: {
|
105
|
+
query?: never;
|
34
106
|
header: {
|
107
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
35
108
|
"Content-Type": components["parameters"]["Content-Type"];
|
109
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
36
110
|
Date: components["parameters"]["Date"];
|
111
|
+
/** @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.
|
112
|
+
*
|
113
|
+
* **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`. */
|
37
114
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
115
|
+
/** @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`). */
|
38
116
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
117
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
39
118
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
119
|
+
/** @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. */
|
40
120
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
121
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
41
122
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
123
|
+
/** @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). */
|
42
124
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
125
|
+
/** @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). */
|
43
126
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
44
127
|
};
|
45
128
|
path: {
|
129
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
46
130
|
Type: components["parameters"]["Type"];
|
131
|
+
/** @description The identifier value. */
|
47
132
|
ID: components["parameters"]["ID"];
|
133
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
134
|
+
SubId: components["parameters"]["SubId"];
|
48
135
|
};
|
136
|
+
cookie?: never;
|
49
137
|
};
|
50
|
-
};
|
51
|
-
"/participants/{Type}/{ID}/error": {
|
52
|
-
/**
|
53
|
-
* Return participant information error
|
54
|
-
* @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.
|
55
|
-
*/
|
56
|
-
put: operations["ParticipantsErrorByTypeAndID"];
|
57
|
-
};
|
58
|
-
"/participants/{Type}/{ID}/{SubId}": {
|
59
138
|
/**
|
60
139
|
* Look up participant information
|
61
140
|
* @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.
|
@@ -75,179 +154,375 @@ export interface paths {
|
|
75
154
|
* Delete participant information
|
76
155
|
* @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.
|
77
156
|
*
|
78
|
-
*
|
157
|
+
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
79
158
|
*/
|
80
159
|
delete: operations["ParticipantsSubIdByTypeAndID2"];
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
86
|
-
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
87
|
-
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
88
|
-
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
89
|
-
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
90
|
-
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
91
|
-
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
92
|
-
};
|
93
|
-
path: {
|
94
|
-
Type: components["parameters"]["Type"];
|
95
|
-
ID: components["parameters"]["ID"];
|
96
|
-
SubId: components["parameters"]["SubId"];
|
97
|
-
};
|
98
|
-
};
|
160
|
+
options?: never;
|
161
|
+
head?: never;
|
162
|
+
patch?: never;
|
163
|
+
trace?: never;
|
99
164
|
};
|
100
165
|
"/participants/{Type}/{ID}/{SubId}/error": {
|
166
|
+
parameters: {
|
167
|
+
query?: never;
|
168
|
+
header?: never;
|
169
|
+
path?: never;
|
170
|
+
cookie?: never;
|
171
|
+
};
|
172
|
+
get?: never;
|
101
173
|
/**
|
102
174
|
* Return participant information error
|
103
175
|
* @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.
|
104
176
|
*/
|
105
177
|
put: operations["ParticipantsSubIdErrorByTypeAndID"];
|
178
|
+
post?: never;
|
179
|
+
delete?: never;
|
180
|
+
options?: never;
|
181
|
+
head?: never;
|
182
|
+
patch?: never;
|
183
|
+
trace?: never;
|
106
184
|
};
|
107
185
|
"/participants": {
|
186
|
+
parameters: {
|
187
|
+
query?: never;
|
188
|
+
header?: never;
|
189
|
+
path?: never;
|
190
|
+
cookie?: never;
|
191
|
+
};
|
192
|
+
get?: never;
|
193
|
+
put?: never;
|
108
194
|
/**
|
109
195
|
* Create bulk participant information
|
110
196
|
* @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.
|
111
197
|
*/
|
112
198
|
post: operations["Participants1"];
|
199
|
+
delete?: never;
|
200
|
+
options?: never;
|
201
|
+
head?: never;
|
202
|
+
patch?: never;
|
203
|
+
trace?: never;
|
113
204
|
};
|
114
205
|
"/participants/{ID}": {
|
206
|
+
parameters: {
|
207
|
+
query?: never;
|
208
|
+
header?: never;
|
209
|
+
path?: never;
|
210
|
+
cookie?: never;
|
211
|
+
};
|
212
|
+
get?: never;
|
115
213
|
/**
|
116
214
|
* Return bulk participant information
|
117
215
|
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
118
216
|
*/
|
119
217
|
put: operations["putParticipantsByID"];
|
218
|
+
post?: never;
|
219
|
+
delete?: never;
|
220
|
+
options?: never;
|
221
|
+
head?: never;
|
222
|
+
patch?: never;
|
223
|
+
trace?: never;
|
120
224
|
};
|
121
225
|
"/participants/{ID}/error": {
|
226
|
+
parameters: {
|
227
|
+
query?: never;
|
228
|
+
header?: never;
|
229
|
+
path?: never;
|
230
|
+
cookie?: never;
|
231
|
+
};
|
232
|
+
get?: never;
|
122
233
|
/**
|
123
234
|
* Return bulk participant information error
|
124
235
|
* @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.
|
125
236
|
*/
|
126
237
|
put: operations["ParticipantsByIDAndError"];
|
238
|
+
post?: never;
|
239
|
+
delete?: never;
|
240
|
+
options?: never;
|
241
|
+
head?: never;
|
242
|
+
patch?: never;
|
243
|
+
trace?: never;
|
127
244
|
};
|
128
245
|
"/parties/{Type}/{ID}": {
|
129
|
-
/**
|
130
|
-
* Look up party information
|
131
|
-
* @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`).
|
132
|
-
*/
|
133
|
-
get: operations["PartiesByTypeAndID"];
|
134
|
-
/**
|
135
|
-
* Return party information
|
136
|
-
* @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.
|
137
|
-
*/
|
138
|
-
put: operations["PartiesByTypeAndID2"];
|
139
246
|
parameters: {
|
247
|
+
query?: never;
|
140
248
|
header: {
|
249
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
141
250
|
"Content-Type": components["parameters"]["Content-Type"];
|
251
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
142
252
|
Date: components["parameters"]["Date"];
|
253
|
+
/** @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.
|
254
|
+
*
|
255
|
+
* **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`. */
|
143
256
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
257
|
+
/** @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`). */
|
144
258
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
259
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
145
260
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
261
|
+
/** @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. */
|
146
262
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
263
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
147
264
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
265
|
+
/** @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). */
|
148
266
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
267
|
+
/** @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). */
|
149
268
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
150
269
|
};
|
151
270
|
path: {
|
271
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
152
272
|
Type: components["parameters"]["Type"];
|
273
|
+
/** @description The identifier value. */
|
153
274
|
ID: components["parameters"]["ID"];
|
154
275
|
};
|
276
|
+
cookie?: never;
|
155
277
|
};
|
278
|
+
/**
|
279
|
+
* Look up party information
|
280
|
+
* @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`).
|
281
|
+
*/
|
282
|
+
get: operations["PartiesByTypeAndID"];
|
283
|
+
/**
|
284
|
+
* Return party information
|
285
|
+
* @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.
|
286
|
+
*/
|
287
|
+
put: operations["PartiesByTypeAndID2"];
|
288
|
+
post?: never;
|
289
|
+
delete?: never;
|
290
|
+
options?: never;
|
291
|
+
head?: never;
|
292
|
+
patch?: never;
|
293
|
+
trace?: never;
|
156
294
|
};
|
157
295
|
"/parties/{Type}/{ID}/error": {
|
296
|
+
parameters: {
|
297
|
+
query?: never;
|
298
|
+
header?: never;
|
299
|
+
path?: never;
|
300
|
+
cookie?: never;
|
301
|
+
};
|
302
|
+
get?: never;
|
158
303
|
/**
|
159
304
|
* Return party information error
|
160
305
|
* @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.
|
161
306
|
*/
|
162
307
|
put: operations["PartiesErrorByTypeAndID"];
|
308
|
+
post?: never;
|
309
|
+
delete?: never;
|
310
|
+
options?: never;
|
311
|
+
head?: never;
|
312
|
+
patch?: never;
|
313
|
+
trace?: never;
|
163
314
|
};
|
164
315
|
"/parties/{Type}/{ID}/{SubId}": {
|
165
|
-
/**
|
166
|
-
* Look up party information
|
167
|
-
* @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`).
|
168
|
-
*/
|
169
|
-
get: operations["PartiesSubIdByTypeAndID"];
|
170
|
-
/**
|
171
|
-
* Return party information
|
172
|
-
* @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.
|
173
|
-
*/
|
174
|
-
put: operations["PartiesSubIdByTypeAndIDPut"];
|
175
316
|
parameters: {
|
317
|
+
query?: never;
|
176
318
|
header: {
|
319
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
177
320
|
"Content-Type": components["parameters"]["Content-Type"];
|
321
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
178
322
|
Date: components["parameters"]["Date"];
|
323
|
+
/** @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.
|
324
|
+
*
|
325
|
+
* **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`. */
|
179
326
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
327
|
+
/** @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`). */
|
180
328
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
329
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
181
330
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
331
|
+
/** @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. */
|
182
332
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
333
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
183
334
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
335
|
+
/** @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). */
|
184
336
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
337
|
+
/** @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). */
|
185
338
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
186
339
|
};
|
187
340
|
path: {
|
341
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
188
342
|
Type: components["parameters"]["Type"];
|
343
|
+
/** @description The identifier value. */
|
189
344
|
ID: components["parameters"]["ID"];
|
345
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
190
346
|
SubId: components["parameters"]["SubId"];
|
191
347
|
};
|
348
|
+
cookie?: never;
|
192
349
|
};
|
350
|
+
/**
|
351
|
+
* Look up party information
|
352
|
+
* @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`).
|
353
|
+
*/
|
354
|
+
get: operations["PartiesSubIdByTypeAndID"];
|
355
|
+
/**
|
356
|
+
* Return party information
|
357
|
+
* @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.
|
358
|
+
*/
|
359
|
+
put: operations["PartiesSubIdByTypeAndIDPut"];
|
360
|
+
post?: never;
|
361
|
+
delete?: never;
|
362
|
+
options?: never;
|
363
|
+
head?: never;
|
364
|
+
patch?: never;
|
365
|
+
trace?: never;
|
193
366
|
};
|
194
367
|
"/parties/{Type}/{ID}/{SubId}/error": {
|
368
|
+
parameters: {
|
369
|
+
query?: never;
|
370
|
+
header?: never;
|
371
|
+
path?: never;
|
372
|
+
cookie?: never;
|
373
|
+
};
|
374
|
+
get?: never;
|
195
375
|
/**
|
196
376
|
* Return party information error
|
197
377
|
* @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.
|
198
378
|
*/
|
199
379
|
put: operations["PartiesSubIdErrorByTypeAndID"];
|
380
|
+
post?: never;
|
381
|
+
delete?: never;
|
382
|
+
options?: never;
|
383
|
+
head?: never;
|
384
|
+
patch?: never;
|
385
|
+
trace?: never;
|
200
386
|
};
|
201
387
|
"/transactionRequests": {
|
388
|
+
parameters: {
|
389
|
+
query?: never;
|
390
|
+
header?: never;
|
391
|
+
path?: never;
|
392
|
+
cookie?: never;
|
393
|
+
};
|
394
|
+
get?: never;
|
395
|
+
put?: never;
|
202
396
|
/**
|
203
397
|
* Perform transaction request
|
204
398
|
* @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
|
205
399
|
*/
|
206
400
|
post: operations["TransactionRequests"];
|
401
|
+
delete?: never;
|
402
|
+
options?: never;
|
403
|
+
head?: never;
|
404
|
+
patch?: never;
|
405
|
+
trace?: never;
|
207
406
|
};
|
208
407
|
"/transactionRequests/{ID}": {
|
209
|
-
/**
|
210
|
-
* Retrieve transaction request information
|
211
|
-
* @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.
|
212
|
-
*/
|
213
|
-
get: operations["TransactionRequestsByID"];
|
214
|
-
/**
|
215
|
-
* Return transaction request information
|
216
|
-
* @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}`.
|
217
|
-
*/
|
218
|
-
put: operations["TransactionRequestsByIDPut"];
|
219
408
|
parameters: {
|
409
|
+
query?: never;
|
220
410
|
header: {
|
411
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
221
412
|
"Content-Type": components["parameters"]["Content-Type"];
|
413
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
222
414
|
Date: components["parameters"]["Date"];
|
415
|
+
/** @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.
|
416
|
+
*
|
417
|
+
* **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`. */
|
223
418
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
419
|
+
/** @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`). */
|
224
420
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
421
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
225
422
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
423
|
+
/** @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. */
|
226
424
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
425
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
227
426
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
427
|
+
/** @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). */
|
228
428
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
429
|
+
/** @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). */
|
229
430
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
230
431
|
};
|
231
432
|
path: {
|
433
|
+
/** @description The identifier value. */
|
232
434
|
ID: components["parameters"]["ID"];
|
233
435
|
};
|
436
|
+
cookie?: never;
|
234
437
|
};
|
438
|
+
/**
|
439
|
+
* Retrieve transaction request information
|
440
|
+
* @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.
|
441
|
+
*/
|
442
|
+
get: operations["TransactionRequestsByID"];
|
443
|
+
/**
|
444
|
+
* Return transaction request information
|
445
|
+
* @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}`.
|
446
|
+
*/
|
447
|
+
put: operations["TransactionRequestsByIDPut"];
|
448
|
+
post?: never;
|
449
|
+
delete?: never;
|
450
|
+
options?: never;
|
451
|
+
head?: never;
|
452
|
+
patch?: never;
|
453
|
+
trace?: never;
|
235
454
|
};
|
236
455
|
"/transactionRequests/{ID}/error": {
|
456
|
+
parameters: {
|
457
|
+
query?: never;
|
458
|
+
header?: never;
|
459
|
+
path?: never;
|
460
|
+
cookie?: never;
|
461
|
+
};
|
462
|
+
get?: never;
|
237
463
|
/**
|
238
464
|
* Return transaction request information error
|
239
465
|
* @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}`.
|
240
466
|
*/
|
241
467
|
put: operations["TransactionRequestsErrorByID"];
|
468
|
+
post?: never;
|
469
|
+
delete?: never;
|
470
|
+
options?: never;
|
471
|
+
head?: never;
|
472
|
+
patch?: never;
|
473
|
+
trace?: never;
|
242
474
|
};
|
243
475
|
"/quotes": {
|
476
|
+
parameters: {
|
477
|
+
query?: never;
|
478
|
+
header?: never;
|
479
|
+
path?: never;
|
480
|
+
cookie?: never;
|
481
|
+
};
|
482
|
+
get?: never;
|
483
|
+
put?: never;
|
244
484
|
/**
|
245
485
|
* Calculate quote
|
246
486
|
* @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
|
247
487
|
*/
|
248
488
|
post: operations["Quotes"];
|
489
|
+
delete?: never;
|
490
|
+
options?: never;
|
491
|
+
head?: never;
|
492
|
+
patch?: never;
|
493
|
+
trace?: never;
|
249
494
|
};
|
250
495
|
"/quotes/{ID}": {
|
496
|
+
parameters: {
|
497
|
+
query?: never;
|
498
|
+
header: {
|
499
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
500
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
501
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
502
|
+
Date: components["parameters"]["Date"];
|
503
|
+
/** @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.
|
504
|
+
*
|
505
|
+
* **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`. */
|
506
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
507
|
+
/** @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`). */
|
508
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
509
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
510
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
511
|
+
/** @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. */
|
512
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
513
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
514
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
515
|
+
/** @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). */
|
516
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
517
|
+
/** @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). */
|
518
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
519
|
+
};
|
520
|
+
path: {
|
521
|
+
/** @description The identifier value. */
|
522
|
+
ID: components["parameters"]["ID"];
|
523
|
+
};
|
524
|
+
cookie?: never;
|
525
|
+
};
|
251
526
|
/**
|
252
527
|
* Retrieve quote information
|
253
528
|
* @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.
|
@@ -258,46 +533,79 @@ export interface paths {
|
|
258
533
|
* @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.
|
259
534
|
*/
|
260
535
|
put: operations["QuotesByID1"];
|
536
|
+
post?: never;
|
537
|
+
delete?: never;
|
538
|
+
options?: never;
|
539
|
+
head?: never;
|
540
|
+
patch?: never;
|
541
|
+
trace?: never;
|
542
|
+
};
|
543
|
+
"/quotes/{ID}/error": {
|
261
544
|
parameters: {
|
545
|
+
query?: never;
|
546
|
+
header?: never;
|
547
|
+
path?: never;
|
548
|
+
cookie?: never;
|
549
|
+
};
|
550
|
+
get?: never;
|
551
|
+
/**
|
552
|
+
* Return quote information error
|
553
|
+
* @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.
|
554
|
+
*/
|
555
|
+
put: operations["QuotesByIDAndError"];
|
556
|
+
post?: never;
|
557
|
+
delete?: never;
|
558
|
+
options?: never;
|
559
|
+
head?: never;
|
560
|
+
patch?: never;
|
561
|
+
trace?: never;
|
562
|
+
};
|
563
|
+
"/authorizations/{ID}": {
|
564
|
+
parameters: {
|
565
|
+
query?: never;
|
262
566
|
header: {
|
567
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
263
568
|
"Content-Type": components["parameters"]["Content-Type"];
|
569
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
264
570
|
Date: components["parameters"]["Date"];
|
571
|
+
/** @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.
|
572
|
+
*
|
573
|
+
* **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`. */
|
265
574
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
575
|
+
/** @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`). */
|
266
576
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
577
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
267
578
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
579
|
+
/** @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. */
|
268
580
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
581
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
269
582
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
583
|
+
/** @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). */
|
270
584
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
585
|
+
/** @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). */
|
271
586
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
272
587
|
};
|
273
588
|
path: {
|
589
|
+
/** @description The identifier value. */
|
274
590
|
ID: components["parameters"]["ID"];
|
275
591
|
};
|
592
|
+
cookie?: never;
|
276
593
|
};
|
277
|
-
};
|
278
|
-
"/quotes/{ID}/error": {
|
279
|
-
/**
|
280
|
-
* Return quote information error
|
281
|
-
* @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.
|
282
|
-
*/
|
283
|
-
put: operations["QuotesByIDAndError"];
|
284
|
-
};
|
285
|
-
"/authorizations/{ID}": {
|
286
594
|
/**
|
287
595
|
* Perform authorization
|
288
596
|
* @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*:*
|
289
597
|
*
|
290
|
-
*
|
598
|
+
* - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
|
291
599
|
*
|
292
|
-
*
|
600
|
+
* - `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.
|
293
601
|
*
|
294
|
-
*
|
602
|
+
* - `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`.
|
295
603
|
*
|
296
|
-
*
|
604
|
+
* - `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`.
|
297
605
|
*
|
298
|
-
*
|
606
|
+
* The following is an example URI containing all the required key-value pairs in the query string*:*
|
299
607
|
*
|
300
|
-
*
|
608
|
+
* `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD`
|
301
609
|
*/
|
302
610
|
get: operations["AuthorizationsByIDGet"];
|
303
611
|
/**
|
@@ -305,190 +613,364 @@ export interface paths {
|
|
305
613
|
* @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.
|
306
614
|
*/
|
307
615
|
put: operations["AuthorizationsByIDPut"];
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
315
|
-
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
316
|
-
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
317
|
-
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
318
|
-
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
319
|
-
};
|
320
|
-
path: {
|
321
|
-
ID: components["parameters"]["ID"];
|
322
|
-
};
|
323
|
-
};
|
616
|
+
post?: never;
|
617
|
+
delete?: never;
|
618
|
+
options?: never;
|
619
|
+
head?: never;
|
620
|
+
patch?: never;
|
621
|
+
trace?: never;
|
324
622
|
};
|
325
623
|
"/authorizations/{ID}/error": {
|
624
|
+
parameters: {
|
625
|
+
query?: never;
|
626
|
+
header?: never;
|
627
|
+
path?: never;
|
628
|
+
cookie?: never;
|
629
|
+
};
|
630
|
+
get?: never;
|
326
631
|
/**
|
327
632
|
* Return authorization error
|
328
633
|
* @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}`.
|
329
634
|
*/
|
330
635
|
put: operations["AuthorizationsByIDAndError"];
|
636
|
+
post?: never;
|
637
|
+
delete?: never;
|
638
|
+
options?: never;
|
639
|
+
head?: never;
|
640
|
+
patch?: never;
|
641
|
+
trace?: never;
|
331
642
|
};
|
332
643
|
"/transfers": {
|
644
|
+
parameters: {
|
645
|
+
query?: never;
|
646
|
+
header?: never;
|
647
|
+
path?: never;
|
648
|
+
cookie?: never;
|
649
|
+
};
|
650
|
+
get?: never;
|
651
|
+
put?: never;
|
333
652
|
/**
|
334
653
|
* Perform transfer
|
335
654
|
* @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.
|
336
655
|
*/
|
337
656
|
post: operations["transfers"];
|
657
|
+
delete?: never;
|
658
|
+
options?: never;
|
659
|
+
head?: never;
|
660
|
+
patch?: never;
|
661
|
+
trace?: never;
|
338
662
|
};
|
339
663
|
"/transfers/{ID}": {
|
340
|
-
/**
|
341
|
-
* Retrieve transfer information
|
342
|
-
* @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.
|
343
|
-
*/
|
344
|
-
get: operations["TransfersByIDGet"];
|
345
|
-
/**
|
346
|
-
* Return transfer information
|
347
|
-
* @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.
|
348
|
-
*/
|
349
|
-
put: operations["TransfersByIDPut"];
|
350
664
|
parameters: {
|
665
|
+
query?: never;
|
351
666
|
header: {
|
667
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
352
668
|
"Content-Type": components["parameters"]["Content-Type"];
|
669
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
353
670
|
Date: components["parameters"]["Date"];
|
671
|
+
/** @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.
|
672
|
+
*
|
673
|
+
* **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`. */
|
354
674
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
675
|
+
/** @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`). */
|
355
676
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
677
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
356
678
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
679
|
+
/** @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. */
|
357
680
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
681
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
358
682
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
683
|
+
/** @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). */
|
359
684
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
685
|
+
/** @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). */
|
360
686
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
361
687
|
};
|
362
688
|
path: {
|
689
|
+
/** @description The identifier value. */
|
363
690
|
ID: components["parameters"]["ID"];
|
364
691
|
};
|
692
|
+
cookie?: never;
|
365
693
|
};
|
694
|
+
/**
|
695
|
+
* Retrieve transfer information
|
696
|
+
* @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.
|
697
|
+
*/
|
698
|
+
get: operations["TransfersByIDGet"];
|
699
|
+
/**
|
700
|
+
* Return transfer information
|
701
|
+
* @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.
|
702
|
+
*/
|
703
|
+
put: operations["TransfersByIDPut"];
|
704
|
+
post?: never;
|
705
|
+
delete?: never;
|
706
|
+
options?: never;
|
707
|
+
head?: never;
|
708
|
+
patch?: never;
|
709
|
+
trace?: never;
|
366
710
|
};
|
367
711
|
"/transfers/{ID}/error": {
|
712
|
+
parameters: {
|
713
|
+
query?: never;
|
714
|
+
header?: never;
|
715
|
+
path?: never;
|
716
|
+
cookie?: never;
|
717
|
+
};
|
718
|
+
get?: never;
|
368
719
|
/**
|
369
720
|
* Return transfer information error
|
370
721
|
* @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}`.
|
371
722
|
*/
|
372
723
|
put: operations["TransfersByIDAndError"];
|
724
|
+
post?: never;
|
725
|
+
delete?: never;
|
726
|
+
options?: never;
|
727
|
+
head?: never;
|
728
|
+
patch?: never;
|
729
|
+
trace?: never;
|
373
730
|
};
|
374
731
|
"/transactions/{ID}": {
|
375
|
-
/**
|
376
|
-
* Retrieve transaction information
|
377
|
-
* @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).
|
378
|
-
*/
|
379
|
-
get: operations["TransactionsByID"];
|
380
|
-
/**
|
381
|
-
* Return transaction information
|
382
|
-
* @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.
|
383
|
-
*/
|
384
|
-
put: operations["TransactionsByID1"];
|
385
732
|
parameters: {
|
733
|
+
query?: never;
|
386
734
|
header: {
|
735
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
387
736
|
"Content-Type": components["parameters"]["Content-Type"];
|
737
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
388
738
|
Date: components["parameters"]["Date"];
|
739
|
+
/** @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.
|
740
|
+
*
|
741
|
+
* **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`. */
|
389
742
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
743
|
+
/** @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`). */
|
390
744
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
745
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
391
746
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
747
|
+
/** @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. */
|
392
748
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
749
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
393
750
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
751
|
+
/** @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). */
|
394
752
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
753
|
+
/** @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). */
|
395
754
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
396
755
|
};
|
397
756
|
path: {
|
757
|
+
/** @description The identifier value. */
|
398
758
|
ID: components["parameters"]["ID"];
|
399
759
|
};
|
760
|
+
cookie?: never;
|
400
761
|
};
|
762
|
+
/**
|
763
|
+
* Retrieve transaction information
|
764
|
+
* @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).
|
765
|
+
*/
|
766
|
+
get: operations["TransactionsByID"];
|
767
|
+
/**
|
768
|
+
* Return transaction information
|
769
|
+
* @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.
|
770
|
+
*/
|
771
|
+
put: operations["TransactionsByID1"];
|
772
|
+
post?: never;
|
773
|
+
delete?: never;
|
774
|
+
options?: never;
|
775
|
+
head?: never;
|
776
|
+
patch?: never;
|
777
|
+
trace?: never;
|
401
778
|
};
|
402
779
|
"/transactions/{ID}/error": {
|
780
|
+
parameters: {
|
781
|
+
query?: never;
|
782
|
+
header?: never;
|
783
|
+
path?: never;
|
784
|
+
cookie?: never;
|
785
|
+
};
|
786
|
+
get?: never;
|
403
787
|
/**
|
404
788
|
* Return transaction information error
|
405
789
|
* @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.
|
406
790
|
*/
|
407
791
|
put: operations["TransactionsErrorByID"];
|
792
|
+
post?: never;
|
793
|
+
delete?: never;
|
794
|
+
options?: never;
|
795
|
+
head?: never;
|
796
|
+
patch?: never;
|
797
|
+
trace?: never;
|
408
798
|
};
|
409
799
|
"/bulkQuotes": {
|
800
|
+
parameters: {
|
801
|
+
query?: never;
|
802
|
+
header?: never;
|
803
|
+
path?: never;
|
804
|
+
cookie?: never;
|
805
|
+
};
|
806
|
+
get?: never;
|
807
|
+
put?: never;
|
410
808
|
/**
|
411
809
|
* Calculate bulk quote
|
412
810
|
* @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
|
413
811
|
*/
|
414
812
|
post: operations["BulkQuotes"];
|
813
|
+
delete?: never;
|
814
|
+
options?: never;
|
815
|
+
head?: never;
|
816
|
+
patch?: never;
|
817
|
+
trace?: never;
|
415
818
|
};
|
416
819
|
"/bulkQuotes/{ID}": {
|
417
|
-
/**
|
418
|
-
* Retrieve bulk quote information
|
419
|
-
* @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.
|
420
|
-
*/
|
421
|
-
get: operations["BulkQuotesByID"];
|
422
|
-
/**
|
423
|
-
* Return bulk quote information
|
424
|
-
* @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.
|
425
|
-
*/
|
426
|
-
put: operations["BulkQuotesByID1"];
|
427
820
|
parameters: {
|
821
|
+
query?: never;
|
428
822
|
header: {
|
823
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
429
824
|
"Content-Type": components["parameters"]["Content-Type"];
|
825
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
430
826
|
Date: components["parameters"]["Date"];
|
827
|
+
/** @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.
|
828
|
+
*
|
829
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
431
830
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
831
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
432
832
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
833
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
433
834
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
835
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
434
836
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
837
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
435
838
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
839
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
436
840
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
841
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
437
842
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
438
843
|
};
|
439
844
|
path: {
|
845
|
+
/** @description The identifier value. */
|
440
846
|
ID: components["parameters"]["ID"];
|
441
847
|
};
|
848
|
+
cookie?: never;
|
442
849
|
};
|
850
|
+
/**
|
851
|
+
* Retrieve bulk quote information
|
852
|
+
* @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.
|
853
|
+
*/
|
854
|
+
get: operations["BulkQuotesByID"];
|
855
|
+
/**
|
856
|
+
* Return bulk quote information
|
857
|
+
* @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.
|
858
|
+
*/
|
859
|
+
put: operations["BulkQuotesByID1"];
|
860
|
+
post?: never;
|
861
|
+
delete?: never;
|
862
|
+
options?: never;
|
863
|
+
head?: never;
|
864
|
+
patch?: never;
|
865
|
+
trace?: never;
|
443
866
|
};
|
444
867
|
"/bulkQuotes/{ID}/error": {
|
868
|
+
parameters: {
|
869
|
+
query?: never;
|
870
|
+
header?: never;
|
871
|
+
path?: never;
|
872
|
+
cookie?: never;
|
873
|
+
};
|
874
|
+
get?: never;
|
445
875
|
/**
|
446
876
|
* Return bulk quote information error
|
447
877
|
* @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.
|
448
878
|
*/
|
449
879
|
put: operations["BulkQuotesErrorByID"];
|
880
|
+
post?: never;
|
881
|
+
delete?: never;
|
882
|
+
options?: never;
|
883
|
+
head?: never;
|
884
|
+
patch?: never;
|
885
|
+
trace?: never;
|
450
886
|
};
|
451
887
|
"/bulkTransfers": {
|
888
|
+
parameters: {
|
889
|
+
query?: never;
|
890
|
+
header?: never;
|
891
|
+
path?: never;
|
892
|
+
cookie?: never;
|
893
|
+
};
|
894
|
+
get?: never;
|
895
|
+
put?: never;
|
452
896
|
/**
|
453
897
|
* Perform bulk transfer
|
454
898
|
* @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
|
455
899
|
*/
|
456
900
|
post: operations["BulkTransfers"];
|
901
|
+
delete?: never;
|
902
|
+
options?: never;
|
903
|
+
head?: never;
|
904
|
+
patch?: never;
|
905
|
+
trace?: never;
|
457
906
|
};
|
458
907
|
"/bulkTransfers/{ID}": {
|
459
|
-
/**
|
460
|
-
* Retrieve bulk transfer information
|
461
|
-
* @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.
|
462
|
-
*/
|
463
|
-
get: operations["BulkTransferByID"];
|
464
|
-
/**
|
465
|
-
* Return bulk transfer information
|
466
|
-
* @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.
|
467
|
-
*/
|
468
|
-
put: operations["BulkTransfersByIDPut"];
|
469
908
|
parameters: {
|
909
|
+
query?: never;
|
470
910
|
header: {
|
911
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
471
912
|
"Content-Type": components["parameters"]["Content-Type"];
|
913
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
472
914
|
Date: components["parameters"]["Date"];
|
915
|
+
/** @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.
|
916
|
+
*
|
917
|
+
* **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`. */
|
473
918
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
919
|
+
/** @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`). */
|
474
920
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
921
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
475
922
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
923
|
+
/** @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. */
|
476
924
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
925
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
477
926
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
927
|
+
/** @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). */
|
478
928
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
929
|
+
/** @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). */
|
479
930
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
480
931
|
};
|
481
932
|
path: {
|
933
|
+
/** @description The identifier value. */
|
482
934
|
ID: components["parameters"]["ID"];
|
483
935
|
};
|
936
|
+
cookie?: never;
|
484
937
|
};
|
938
|
+
/**
|
939
|
+
* Retrieve bulk transfer information
|
940
|
+
* @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.
|
941
|
+
*/
|
942
|
+
get: operations["BulkTransferByID"];
|
943
|
+
/**
|
944
|
+
* Return bulk transfer information
|
945
|
+
* @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.
|
946
|
+
*/
|
947
|
+
put: operations["BulkTransfersByIDPut"];
|
948
|
+
post?: never;
|
949
|
+
delete?: never;
|
950
|
+
options?: never;
|
951
|
+
head?: never;
|
952
|
+
patch?: never;
|
953
|
+
trace?: never;
|
485
954
|
};
|
486
955
|
"/bulkTransfers/{ID}/error": {
|
956
|
+
parameters: {
|
957
|
+
query?: never;
|
958
|
+
header?: never;
|
959
|
+
path?: never;
|
960
|
+
cookie?: never;
|
961
|
+
};
|
962
|
+
get?: never;
|
487
963
|
/**
|
488
964
|
* Return bulk transfer information error
|
489
965
|
* @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.
|
490
966
|
*/
|
491
967
|
put: operations["BulkTransfersErrorByID"];
|
968
|
+
post?: never;
|
969
|
+
delete?: never;
|
970
|
+
options?: never;
|
971
|
+
head?: never;
|
972
|
+
patch?: never;
|
973
|
+
trace?: never;
|
492
974
|
};
|
493
975
|
}
|
494
976
|
export type webhooks = Record<string, never>;
|
@@ -502,8 +984,8 @@ export interface components {
|
|
502
984
|
/**
|
503
985
|
* AmountType
|
504
986
|
* @description Below are the allowed values for the enumeration AmountType.
|
505
|
-
*
|
506
|
-
*
|
987
|
+
* - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
988
|
+
* - 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.
|
507
989
|
* @enum {string}
|
508
990
|
*/
|
509
991
|
AmountType: "SEND" | "RECEIVE";
|
@@ -526,8 +1008,8 @@ export interface components {
|
|
526
1008
|
/**
|
527
1009
|
* AuthenticationType
|
528
1010
|
* @description Below are the allowed values for the enumeration AuthenticationType.
|
529
|
-
*
|
530
|
-
*
|
1011
|
+
* - OTP - One-time password generated by the Payer FSP.
|
1012
|
+
* - QRCODE - QR code used as One Time Password.
|
531
1013
|
* @enum {string}
|
532
1014
|
*/
|
533
1015
|
AuthenticationType: "OTP" | "QRCODE";
|
@@ -549,9 +1031,9 @@ export interface components {
|
|
549
1031
|
/**
|
550
1032
|
* AuthorizationResponse
|
551
1033
|
* @description Below are the allowed values for the enumeration.
|
552
|
-
*
|
553
|
-
*
|
554
|
-
*
|
1034
|
+
* - ENTERED - Consumer entered the authentication value.
|
1035
|
+
* - REJECTED - Consumer rejected the transaction.
|
1036
|
+
* - RESEND - Consumer requested to resend the authentication value.
|
555
1037
|
* @enum {string}
|
556
1038
|
*/
|
557
1039
|
AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND";
|
@@ -567,12 +1049,12 @@ export interface components {
|
|
567
1049
|
/**
|
568
1050
|
* BulkTransactionState
|
569
1051
|
* @description Below are the allowed values for the enumeration.
|
570
|
-
*
|
571
|
-
*
|
572
|
-
*
|
573
|
-
*
|
574
|
-
*
|
575
|
-
*
|
1052
|
+
* - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
|
1053
|
+
* - PENDING - Payee FSP has validated the bulk transfer.
|
1054
|
+
* - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
|
1055
|
+
* - PROCESSING - Payee FSP has started to transfer fund to the Payees.
|
1056
|
+
* - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
|
1057
|
+
* - REJECTED - Payee FSP has rejected to process the bulk transfer.
|
576
1058
|
* @enum {string}
|
577
1059
|
*/
|
578
1060
|
BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED";
|
@@ -889,9 +1371,9 @@ export interface components {
|
|
889
1371
|
* Name
|
890
1372
|
* @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.
|
891
1373
|
*
|
892
|
-
*
|
1374
|
+
* 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 ( ).
|
893
1375
|
*
|
894
|
-
*
|
1376
|
+
* **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.
|
895
1377
|
*/
|
896
1378
|
Name: string;
|
897
1379
|
/**
|
@@ -907,14 +1389,14 @@ export interface components {
|
|
907
1389
|
/**
|
908
1390
|
* PartyIdType
|
909
1391
|
* @description Below are the allowed values for the enumeration.
|
910
|
-
*
|
911
|
-
*
|
912
|
-
*
|
913
|
-
*
|
914
|
-
*
|
915
|
-
*
|
916
|
-
*
|
917
|
-
*
|
1392
|
+
* - 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.
|
1393
|
+
* - 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).
|
1394
|
+
* - 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.
|
1395
|
+
* - 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.
|
1396
|
+
* - 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.
|
1397
|
+
* - 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.
|
1398
|
+
* - 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.
|
1399
|
+
* - 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.
|
918
1400
|
* @enum {string}
|
919
1401
|
*/
|
920
1402
|
PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
|
@@ -931,19 +1413,19 @@ export interface components {
|
|
931
1413
|
/**
|
932
1414
|
* PersonalIdentifierType
|
933
1415
|
* @description Below are the allowed values for the enumeration.
|
934
|
-
*
|
935
|
-
*
|
936
|
-
*
|
937
|
-
*
|
938
|
-
*
|
939
|
-
*
|
940
|
-
*
|
941
|
-
*
|
942
|
-
*
|
943
|
-
*
|
944
|
-
*
|
945
|
-
*
|
946
|
-
*
|
1416
|
+
* - PASSPORT - A passport number is used as reference to a Party.
|
1417
|
+
* - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party.
|
1418
|
+
* - DRIVING_LICENSE - A driving license is used as reference to a Party.
|
1419
|
+
* - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party.
|
1420
|
+
* - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party.
|
1421
|
+
* - EMPLOYER_ID - A tax identification number is used as reference to a Party.
|
1422
|
+
* - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
|
1423
|
+
* - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
|
1424
|
+
* - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
|
1425
|
+
* - HEALTH_CARD - A health card number is used as reference to a Party.
|
1426
|
+
* - VOTERS_ID - A voter’s identification number is used as reference to a Party.
|
1427
|
+
* - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
|
1428
|
+
* - OTHER_ID - Any other type of identification type number is used as reference to a Party.
|
947
1429
|
* @enum {string}
|
948
1430
|
*/
|
949
1431
|
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";
|
@@ -998,49 +1480,49 @@ export interface components {
|
|
998
1480
|
/**
|
999
1481
|
* TransactionInitiator
|
1000
1482
|
* @description Below are the allowed values for the enumeration.
|
1001
|
-
*
|
1002
|
-
*
|
1483
|
+
* - 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.
|
1484
|
+
* - 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.
|
1003
1485
|
* @enum {string}
|
1004
1486
|
*/
|
1005
1487
|
TransactionInitiator: "PAYER" | "PAYEE";
|
1006
1488
|
/**
|
1007
1489
|
* TransactionInitiatorType
|
1008
1490
|
* @description Below are the allowed values for the enumeration.
|
1009
|
-
*
|
1010
|
-
*
|
1011
|
-
*
|
1012
|
-
*
|
1491
|
+
* - CONSUMER - Consumer is the initiator of the transaction.
|
1492
|
+
* - AGENT - Agent is the initiator of the transaction.
|
1493
|
+
* - BUSINESS - Business is the initiator of the transaction.
|
1494
|
+
* - DEVICE - Device is the initiator of the transaction.
|
1013
1495
|
* @enum {string}
|
1014
1496
|
*/
|
1015
1497
|
TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
|
1016
1498
|
/**
|
1017
1499
|
* TransactionRequestState
|
1018
1500
|
* @description Below are the allowed values for the enumeration.
|
1019
|
-
*
|
1020
|
-
*
|
1021
|
-
*
|
1022
|
-
*
|
1501
|
+
* - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
|
1502
|
+
* - PENDING - Payer FSP has sent the transaction request to the Payer.
|
1503
|
+
* - ACCEPTED - Payer has approved the transaction.
|
1504
|
+
* - REJECTED - Payer has rejected the transaction.
|
1023
1505
|
* @enum {string}
|
1024
1506
|
*/
|
1025
1507
|
TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED";
|
1026
1508
|
/**
|
1027
1509
|
* TransactionScenario
|
1028
1510
|
* @description Below are the allowed values for the enumeration.
|
1029
|
-
*
|
1030
|
-
*
|
1031
|
-
*
|
1032
|
-
*
|
1033
|
-
*
|
1511
|
+
* - 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.
|
1512
|
+
* - 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.
|
1513
|
+
* - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
1514
|
+
* - 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.
|
1515
|
+
* - REFUND - Used for performing a refund of transaction.
|
1034
1516
|
* @enum {string}
|
1035
1517
|
*/
|
1036
1518
|
TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND";
|
1037
1519
|
/**
|
1038
1520
|
* TransactionState
|
1039
1521
|
* @description Below are the allowed values for the enumeration.
|
1040
|
-
*
|
1041
|
-
*
|
1042
|
-
*
|
1043
|
-
*
|
1522
|
+
* - RECEIVED - Payee FSP has received the transaction from the Payer FSP.
|
1523
|
+
* - PENDING - Payee FSP has validated the transaction.
|
1524
|
+
* - COMPLETED - Payee FSP has successfully performed the transaction.
|
1525
|
+
* - REJECTED - Payee FSP has failed to perform the transaction.
|
1044
1526
|
* @enum {string}
|
1045
1527
|
*/
|
1046
1528
|
TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED";
|
@@ -1052,10 +1534,10 @@ export interface components {
|
|
1052
1534
|
/**
|
1053
1535
|
* TransferState
|
1054
1536
|
* @description Below are the allowed values for the enumeration.
|
1055
|
-
*
|
1056
|
-
*
|
1057
|
-
*
|
1058
|
-
*
|
1537
|
+
* - RECEIVED - Next ledger has received the transfer.
|
1538
|
+
* - RESERVED - Next ledger has reserved the transfer.
|
1539
|
+
* - COMMITTED - Next ledger has successfully performed the transfer.
|
1540
|
+
* - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
|
1059
1541
|
* @enum {string}
|
1060
1542
|
*/
|
1061
1543
|
TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
|
@@ -1837,17 +2319,24 @@ export interface components {
|
|
1837
2319
|
responses: {
|
1838
2320
|
/** @description OK */
|
1839
2321
|
200: {
|
1840
|
-
|
2322
|
+
headers: {
|
2323
|
+
[name: string]: unknown;
|
2324
|
+
};
|
2325
|
+
content?: never;
|
1841
2326
|
};
|
1842
2327
|
/** @description Accepted */
|
1843
2328
|
202: {
|
1844
|
-
|
2329
|
+
headers: {
|
2330
|
+
[name: string]: unknown;
|
2331
|
+
};
|
2332
|
+
content?: never;
|
1845
2333
|
};
|
1846
2334
|
/** @description Bad Request */
|
1847
2335
|
400: {
|
1848
2336
|
headers: {
|
1849
2337
|
"Content-Length": components["headers"]["Content-Length"];
|
1850
2338
|
"Content-Type": components["headers"]["Content-Type"];
|
2339
|
+
[name: string]: unknown;
|
1851
2340
|
};
|
1852
2341
|
content: {
|
1853
2342
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1858,6 +2347,7 @@ export interface components {
|
|
1858
2347
|
headers: {
|
1859
2348
|
"Content-Length": components["headers"]["Content-Length"];
|
1860
2349
|
"Content-Type": components["headers"]["Content-Type"];
|
2350
|
+
[name: string]: unknown;
|
1861
2351
|
};
|
1862
2352
|
content: {
|
1863
2353
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1868,6 +2358,7 @@ export interface components {
|
|
1868
2358
|
headers: {
|
1869
2359
|
"Content-Length": components["headers"]["Content-Length"];
|
1870
2360
|
"Content-Type": components["headers"]["Content-Type"];
|
2361
|
+
[name: string]: unknown;
|
1871
2362
|
};
|
1872
2363
|
content: {
|
1873
2364
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1878,6 +2369,7 @@ export interface components {
|
|
1878
2369
|
headers: {
|
1879
2370
|
"Content-Length": components["headers"]["Content-Length"];
|
1880
2371
|
"Content-Type": components["headers"]["Content-Type"];
|
2372
|
+
[name: string]: unknown;
|
1881
2373
|
};
|
1882
2374
|
content: {
|
1883
2375
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1888,6 +2380,7 @@ export interface components {
|
|
1888
2380
|
headers: {
|
1889
2381
|
"Content-Length": components["headers"]["Content-Length"];
|
1890
2382
|
"Content-Type": components["headers"]["Content-Type"];
|
2383
|
+
[name: string]: unknown;
|
1891
2384
|
};
|
1892
2385
|
content: {
|
1893
2386
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1898,6 +2391,7 @@ export interface components {
|
|
1898
2391
|
headers: {
|
1899
2392
|
"Content-Length": components["headers"]["Content-Length"];
|
1900
2393
|
"Content-Type": components["headers"]["Content-Type"];
|
2394
|
+
[name: string]: unknown;
|
1901
2395
|
};
|
1902
2396
|
content: {
|
1903
2397
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1908,6 +2402,7 @@ export interface components {
|
|
1908
2402
|
headers: {
|
1909
2403
|
"Content-Length": components["headers"]["Content-Length"];
|
1910
2404
|
"Content-Type": components["headers"]["Content-Type"];
|
2405
|
+
[name: string]: unknown;
|
1911
2406
|
};
|
1912
2407
|
content: {
|
1913
2408
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1918,6 +2413,7 @@ export interface components {
|
|
1918
2413
|
headers: {
|
1919
2414
|
"Content-Length": components["headers"]["Content-Length"];
|
1920
2415
|
"Content-Type": components["headers"]["Content-Type"];
|
2416
|
+
[name: string]: unknown;
|
1921
2417
|
};
|
1922
2418
|
content: {
|
1923
2419
|
"application/json": components["schemas"]["ErrorInformationResponse"];
|
@@ -1933,42 +2429,36 @@ export interface components {
|
|
1933
2429
|
"Content-Type": string;
|
1934
2430
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
1935
2431
|
Date: string;
|
1936
|
-
/**
|
1937
|
-
* @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.
|
2432
|
+
/** @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.
|
1938
2433
|
*
|
1939
|
-
*
|
1940
|
-
|
1941
|
-
"X-Forwarded-For"?: string;
|
2434
|
+
* **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`. */
|
2435
|
+
"X-Forwarded-For": string;
|
1942
2436
|
/** @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`). */
|
1943
2437
|
"FSPIOP-Source": string;
|
1944
2438
|
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
1945
|
-
"FSPIOP-Destination"
|
2439
|
+
"FSPIOP-Destination": string;
|
1946
2440
|
/** @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. */
|
1947
|
-
"FSPIOP-Encryption"
|
2441
|
+
"FSPIOP-Encryption": string;
|
1948
2442
|
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1949
|
-
"FSPIOP-Signature"
|
2443
|
+
"FSPIOP-Signature": string;
|
1950
2444
|
/** @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). */
|
1951
|
-
"FSPIOP-URI"
|
2445
|
+
"FSPIOP-URI": string;
|
1952
2446
|
/** @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). */
|
1953
|
-
"FSPIOP-HTTP-Method"
|
2447
|
+
"FSPIOP-HTTP-Method": string;
|
1954
2448
|
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1955
2449
|
Accept: string;
|
1956
|
-
/**
|
1957
|
-
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2450
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1958
2451
|
*
|
1959
|
-
*
|
1960
|
-
|
1961
|
-
"Content-Length"?: number;
|
2452
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2453
|
+
"Content-Length": number;
|
1962
2454
|
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1963
2455
|
SubId: string;
|
1964
2456
|
};
|
1965
2457
|
requestBodies: never;
|
1966
2458
|
headers: {
|
1967
|
-
/**
|
1968
|
-
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2459
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1969
2460
|
*
|
1970
|
-
*
|
1971
|
-
*/
|
2461
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
1972
2462
|
"Content-Length": number;
|
1973
2463
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1974
2464
|
"Content-Type": string;
|
@@ -1976,10 +2466,14 @@ export interface components {
|
|
1976
2466
|
pathItems: never;
|
1977
2467
|
}
|
1978
2468
|
export type $defs = Record<string, never>;
|
1979
|
-
export type external = Record<string, never>;
|
1980
2469
|
export interface operations {
|
1981
|
-
/** @description Essential path to include schema components that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
1982
2470
|
Interface: {
|
2471
|
+
parameters: {
|
2472
|
+
query?: never;
|
2473
|
+
header?: never;
|
2474
|
+
path?: never;
|
2475
|
+
cookie?: never;
|
2476
|
+
};
|
1983
2477
|
requestBody?: {
|
1984
2478
|
content: {
|
1985
2479
|
"application/json": components["schemas"]["Amount"] | components["schemas"]["AmountType"] | components["schemas"]["AuthenticationInfo"] | components["schemas"]["AuthenticationType"] | components["schemas"]["AuthenticationValue"] | components["schemas"]["AuthorizationResponse"] | components["schemas"]["BalanceOfPayments"] | components["schemas"]["BinaryString"] | components["schemas"]["BinaryString32"] | components["schemas"]["BulkTransferState"] | components["schemas"]["Code"] | components["schemas"]["CorrelationId"] | components["schemas"]["Currency"] | components["schemas"]["Date"] | components["schemas"]["DateOfBirth"] | components["schemas"]["DateTime"] | components["schemas"]["ErrorCode"] | components["schemas"]["ErrorDescription"] | components["schemas"]["ExtensionKey"] | components["schemas"]["ExtensionValue"] | components["schemas"]["FirstName"] | components["schemas"]["FspId"] | components["schemas"]["IlpCondition"] | components["schemas"]["IlpFulfilment"] | components["schemas"]["IlpPacket"] | components["schemas"]["IndividualQuote"] | components["schemas"]["Integer"] | components["schemas"]["LastName"] | components["schemas"]["Latitude"] | components["schemas"]["Longitude"] | components["schemas"]["MerchantClassificationCode"] | components["schemas"]["MiddleName"] | components["schemas"]["Name"] | components["schemas"]["Note"] | components["schemas"]["OtpValue"] | components["schemas"]["PartyIdentifier"] | components["schemas"]["PartyIdType"] | components["schemas"]["PartyName"] | components["schemas"]["PartySubIdOrType"] | components["schemas"]["PersonalIdentifierType"] | components["schemas"]["RefundReason"] | components["schemas"]["QRCODE"] | components["schemas"]["TokenCode"] | components["schemas"]["Transaction"] | components["schemas"]["TransactionInitiator"] | components["schemas"]["TransactionInitiatorType"] | components["schemas"]["TransactionRequestState"] | components["schemas"]["TransactionScenario"] | components["schemas"]["TransactionState"] | components["schemas"]["TransactionSubScenario"] | components["schemas"]["TransferState"] | components["schemas"]["UndefinedEnum"];
|
@@ -1988,33 +2482,49 @@ export interface operations {
|
|
1988
2482
|
responses: {
|
1989
2483
|
/** @description Ok */
|
1990
2484
|
200: {
|
1991
|
-
|
2485
|
+
headers: {
|
2486
|
+
[name: string]: unknown;
|
2487
|
+
};
|
2488
|
+
content?: never;
|
1992
2489
|
};
|
1993
2490
|
};
|
1994
2491
|
};
|
1995
|
-
/**
|
1996
|
-
* Look up participant information
|
1997
|
-
* @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.
|
1998
|
-
*/
|
1999
2492
|
ParticipantsByTypeAndID: {
|
2000
2493
|
parameters: {
|
2494
|
+
query?: never;
|
2001
2495
|
header: {
|
2496
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2002
2497
|
"Content-Type": components["parameters"]["Content-Type"];
|
2498
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2003
2499
|
Date: components["parameters"]["Date"];
|
2500
|
+
/** @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.
|
2501
|
+
*
|
2502
|
+
* **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`. */
|
2004
2503
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2504
|
+
/** @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`). */
|
2005
2505
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2506
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2006
2507
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2508
|
+
/** @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. */
|
2007
2509
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2510
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2008
2511
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2512
|
+
/** @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). */
|
2009
2513
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2514
|
+
/** @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). */
|
2010
2515
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2516
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2011
2517
|
Accept: components["parameters"]["Accept"];
|
2012
2518
|
};
|
2013
2519
|
path: {
|
2520
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2014
2521
|
Type: components["parameters"]["Type"];
|
2522
|
+
/** @description The identifier value. */
|
2015
2523
|
ID: components["parameters"]["ID"];
|
2016
2524
|
};
|
2525
|
+
cookie?: never;
|
2017
2526
|
};
|
2527
|
+
requestBody?: never;
|
2018
2528
|
responses: {
|
2019
2529
|
202: components["responses"]["202"];
|
2020
2530
|
400: components["responses"]["400"];
|
@@ -2027,28 +2537,42 @@ export interface operations {
|
|
2027
2537
|
503: components["responses"]["503"];
|
2028
2538
|
};
|
2029
2539
|
};
|
2030
|
-
/**
|
2031
|
-
* Return participant information
|
2032
|
-
* @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.
|
2033
|
-
*/
|
2034
2540
|
ParticipantsByTypeAndID3: {
|
2035
2541
|
parameters: {
|
2542
|
+
query?: never;
|
2036
2543
|
header: {
|
2544
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2037
2545
|
"Content-Type": components["parameters"]["Content-Type"];
|
2546
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2038
2547
|
Date: components["parameters"]["Date"];
|
2548
|
+
/** @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.
|
2549
|
+
*
|
2550
|
+
* **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`. */
|
2039
2551
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2552
|
+
/** @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`). */
|
2040
2553
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2554
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2041
2555
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2556
|
+
/** @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. */
|
2042
2557
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2558
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2043
2559
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2560
|
+
/** @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). */
|
2044
2561
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2562
|
+
/** @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). */
|
2045
2563
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2564
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2565
|
+
*
|
2566
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2046
2567
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2047
2568
|
};
|
2048
2569
|
path: {
|
2570
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2049
2571
|
Type: components["parameters"]["Type"];
|
2572
|
+
/** @description The identifier value. */
|
2050
2573
|
ID: components["parameters"]["ID"];
|
2051
2574
|
};
|
2575
|
+
cookie?: never;
|
2052
2576
|
};
|
2053
2577
|
/** @description Participant information returned. */
|
2054
2578
|
requestBody: {
|
@@ -2068,29 +2592,44 @@ export interface operations {
|
|
2068
2592
|
503: components["responses"]["503"];
|
2069
2593
|
};
|
2070
2594
|
};
|
2071
|
-
/**
|
2072
|
-
* Create participant information
|
2073
|
-
* @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`).
|
2074
|
-
*/
|
2075
2595
|
ParticipantsByIDAndType: {
|
2076
2596
|
parameters: {
|
2597
|
+
query?: never;
|
2077
2598
|
header: {
|
2599
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2078
2600
|
"Content-Type": components["parameters"]["Content-Type"];
|
2601
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2079
2602
|
Date: components["parameters"]["Date"];
|
2603
|
+
/** @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.
|
2604
|
+
*
|
2605
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2080
2606
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2607
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2081
2608
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2609
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2082
2610
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2611
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2083
2612
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2613
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2084
2614
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2615
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2085
2616
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2617
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2086
2618
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2619
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2087
2620
|
Accept: components["parameters"]["Accept"];
|
2621
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2622
|
+
*
|
2623
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2088
2624
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2089
2625
|
};
|
2090
2626
|
path: {
|
2627
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2091
2628
|
Type: components["parameters"]["Type"];
|
2629
|
+
/** @description The identifier value. */
|
2092
2630
|
ID: components["parameters"]["ID"];
|
2093
2631
|
};
|
2632
|
+
cookie?: never;
|
2094
2633
|
};
|
2095
2634
|
/** @description Participant information to be created. */
|
2096
2635
|
requestBody: {
|
@@ -2110,31 +2649,42 @@ export interface operations {
|
|
2110
2649
|
503: components["responses"]["503"];
|
2111
2650
|
};
|
2112
2651
|
};
|
2113
|
-
/**
|
2114
|
-
* Delete participant information
|
2115
|
-
* @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.
|
2116
|
-
*
|
2117
|
-
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
2118
|
-
*/
|
2119
2652
|
ParticipantsByTypeAndID2: {
|
2120
2653
|
parameters: {
|
2654
|
+
query?: never;
|
2121
2655
|
header: {
|
2656
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2122
2657
|
"Content-Type": components["parameters"]["Content-Type"];
|
2658
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2123
2659
|
Date: components["parameters"]["Date"];
|
2660
|
+
/** @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.
|
2661
|
+
*
|
2662
|
+
* **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`. */
|
2124
2663
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2664
|
+
/** @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`). */
|
2125
2665
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2666
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2126
2667
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2668
|
+
/** @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. */
|
2127
2669
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2670
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2128
2671
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2672
|
+
/** @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). */
|
2129
2673
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2674
|
+
/** @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). */
|
2130
2675
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2676
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2131
2677
|
Accept: components["parameters"]["Accept"];
|
2132
2678
|
};
|
2133
2679
|
path: {
|
2680
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2134
2681
|
Type: components["parameters"]["Type"];
|
2682
|
+
/** @description The identifier value. */
|
2135
2683
|
ID: components["parameters"]["ID"];
|
2136
2684
|
};
|
2685
|
+
cookie?: never;
|
2137
2686
|
};
|
2687
|
+
requestBody?: never;
|
2138
2688
|
responses: {
|
2139
2689
|
202: components["responses"]["202"];
|
2140
2690
|
400: components["responses"]["400"];
|
@@ -2147,28 +2697,42 @@ export interface operations {
|
|
2147
2697
|
503: components["responses"]["503"];
|
2148
2698
|
};
|
2149
2699
|
};
|
2150
|
-
/**
|
2151
|
-
* Return participant information error
|
2152
|
-
* @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.
|
2153
|
-
*/
|
2154
2700
|
ParticipantsErrorByTypeAndID: {
|
2155
2701
|
parameters: {
|
2702
|
+
query?: never;
|
2156
2703
|
header: {
|
2704
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2705
|
+
*
|
2706
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2157
2707
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2708
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2158
2709
|
"Content-Type": components["parameters"]["Content-Type"];
|
2710
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2159
2711
|
Date: components["parameters"]["Date"];
|
2712
|
+
/** @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.
|
2713
|
+
*
|
2714
|
+
* **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`. */
|
2160
2715
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2716
|
+
/** @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`). */
|
2161
2717
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2718
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2162
2719
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2720
|
+
/** @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. */
|
2163
2721
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2722
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2164
2723
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2724
|
+
/** @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). */
|
2165
2725
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2726
|
+
/** @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). */
|
2166
2727
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2167
2728
|
};
|
2168
2729
|
path: {
|
2730
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2169
2731
|
Type: components["parameters"]["Type"];
|
2732
|
+
/** @description The identifier value. */
|
2170
2733
|
ID: components["parameters"]["ID"];
|
2171
2734
|
};
|
2735
|
+
cookie?: never;
|
2172
2736
|
};
|
2173
2737
|
/** @description Details of the error returned. */
|
2174
2738
|
requestBody: {
|
@@ -2188,30 +2752,44 @@ export interface operations {
|
|
2188
2752
|
503: components["responses"]["503"];
|
2189
2753
|
};
|
2190
2754
|
};
|
2191
|
-
/**
|
2192
|
-
* Look up participant information
|
2193
|
-
* @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.
|
2194
|
-
*/
|
2195
2755
|
ParticipantsSubIdByTypeAndID: {
|
2196
2756
|
parameters: {
|
2757
|
+
query?: never;
|
2197
2758
|
header: {
|
2759
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2198
2760
|
"Content-Type": components["parameters"]["Content-Type"];
|
2761
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2199
2762
|
Date: components["parameters"]["Date"];
|
2763
|
+
/** @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.
|
2764
|
+
*
|
2765
|
+
* **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`. */
|
2200
2766
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2767
|
+
/** @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`). */
|
2201
2768
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2769
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2202
2770
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2771
|
+
/** @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. */
|
2203
2772
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2773
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2204
2774
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2775
|
+
/** @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). */
|
2205
2776
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2777
|
+
/** @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). */
|
2206
2778
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2779
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2207
2780
|
Accept: components["parameters"]["Accept"];
|
2208
2781
|
};
|
2209
2782
|
path: {
|
2783
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2210
2784
|
Type: components["parameters"]["Type"];
|
2785
|
+
/** @description The identifier value. */
|
2211
2786
|
ID: components["parameters"]["ID"];
|
2787
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2212
2788
|
SubId: components["parameters"]["SubId"];
|
2213
2789
|
};
|
2790
|
+
cookie?: never;
|
2214
2791
|
};
|
2792
|
+
requestBody?: never;
|
2215
2793
|
responses: {
|
2216
2794
|
202: components["responses"]["202"];
|
2217
2795
|
400: components["responses"]["400"];
|
@@ -2224,29 +2802,44 @@ export interface operations {
|
|
2224
2802
|
503: components["responses"]["503"];
|
2225
2803
|
};
|
2226
2804
|
};
|
2227
|
-
/**
|
2228
|
-
* Return participant information
|
2229
|
-
* @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.
|
2230
|
-
*/
|
2231
2805
|
ParticipantsSubIdByTypeAndID3: {
|
2232
2806
|
parameters: {
|
2807
|
+
query?: never;
|
2233
2808
|
header: {
|
2809
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2234
2810
|
"Content-Type": components["parameters"]["Content-Type"];
|
2811
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2235
2812
|
Date: components["parameters"]["Date"];
|
2813
|
+
/** @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.
|
2814
|
+
*
|
2815
|
+
* **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`. */
|
2236
2816
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2817
|
+
/** @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`). */
|
2237
2818
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2819
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2238
2820
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2821
|
+
/** @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. */
|
2239
2822
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2823
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2240
2824
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2825
|
+
/** @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). */
|
2241
2826
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2827
|
+
/** @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). */
|
2242
2828
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2829
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2830
|
+
*
|
2831
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2243
2832
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2244
2833
|
};
|
2245
2834
|
path: {
|
2835
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2246
2836
|
Type: components["parameters"]["Type"];
|
2837
|
+
/** @description The identifier value. */
|
2247
2838
|
ID: components["parameters"]["ID"];
|
2839
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2248
2840
|
SubId: components["parameters"]["SubId"];
|
2249
2841
|
};
|
2842
|
+
cookie?: never;
|
2250
2843
|
};
|
2251
2844
|
/** @description Participant information returned. */
|
2252
2845
|
requestBody: {
|
@@ -2266,30 +2859,46 @@ export interface operations {
|
|
2266
2859
|
503: components["responses"]["503"];
|
2267
2860
|
};
|
2268
2861
|
};
|
2269
|
-
/**
|
2270
|
-
* Create participant information
|
2271
|
-
* @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`).
|
2272
|
-
*/
|
2273
2862
|
ParticipantsSubIdByTypeAndIDPost: {
|
2274
2863
|
parameters: {
|
2864
|
+
query?: never;
|
2275
2865
|
header: {
|
2866
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2276
2867
|
"Content-Type": components["parameters"]["Content-Type"];
|
2868
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2277
2869
|
Date: components["parameters"]["Date"];
|
2870
|
+
/** @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.
|
2871
|
+
*
|
2872
|
+
* **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`. */
|
2278
2873
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2874
|
+
/** @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`). */
|
2279
2875
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2876
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2280
2877
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2878
|
+
/** @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. */
|
2281
2879
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2880
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2282
2881
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2882
|
+
/** @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). */
|
2283
2883
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2884
|
+
/** @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). */
|
2284
2885
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2886
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2285
2887
|
Accept: components["parameters"]["Accept"];
|
2888
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2889
|
+
*
|
2890
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2286
2891
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2287
2892
|
};
|
2288
2893
|
path: {
|
2894
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2289
2895
|
Type: components["parameters"]["Type"];
|
2896
|
+
/** @description The identifier value. */
|
2290
2897
|
ID: components["parameters"]["ID"];
|
2898
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2291
2899
|
SubId: components["parameters"]["SubId"];
|
2292
2900
|
};
|
2901
|
+
cookie?: never;
|
2293
2902
|
};
|
2294
2903
|
/** @description Participant information to be created. */
|
2295
2904
|
requestBody: {
|
@@ -2309,32 +2918,44 @@ export interface operations {
|
|
2309
2918
|
503: components["responses"]["503"];
|
2310
2919
|
};
|
2311
2920
|
};
|
2312
|
-
/**
|
2313
|
-
* Delete participant information
|
2314
|
-
* @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.
|
2315
|
-
*
|
2316
|
-
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
2317
|
-
*/
|
2318
2921
|
ParticipantsSubIdByTypeAndID2: {
|
2319
2922
|
parameters: {
|
2923
|
+
query?: never;
|
2320
2924
|
header: {
|
2925
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2321
2926
|
"Content-Type": components["parameters"]["Content-Type"];
|
2927
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2322
2928
|
Date: components["parameters"]["Date"];
|
2929
|
+
/** @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.
|
2930
|
+
*
|
2931
|
+
* **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`. */
|
2323
2932
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2933
|
+
/** @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`). */
|
2324
2934
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2935
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2325
2936
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2937
|
+
/** @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. */
|
2326
2938
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2939
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2327
2940
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2941
|
+
/** @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). */
|
2328
2942
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2943
|
+
/** @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). */
|
2329
2944
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2945
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2330
2946
|
Accept: components["parameters"]["Accept"];
|
2331
2947
|
};
|
2332
2948
|
path: {
|
2949
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2333
2950
|
Type: components["parameters"]["Type"];
|
2951
|
+
/** @description The identifier value. */
|
2334
2952
|
ID: components["parameters"]["ID"];
|
2953
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2335
2954
|
SubId: components["parameters"]["SubId"];
|
2336
2955
|
};
|
2956
|
+
cookie?: never;
|
2337
2957
|
};
|
2958
|
+
requestBody?: never;
|
2338
2959
|
responses: {
|
2339
2960
|
202: components["responses"]["202"];
|
2340
2961
|
400: components["responses"]["400"];
|
@@ -2347,29 +2968,44 @@ export interface operations {
|
|
2347
2968
|
503: components["responses"]["503"];
|
2348
2969
|
};
|
2349
2970
|
};
|
2350
|
-
/**
|
2351
|
-
* Return participant information error
|
2352
|
-
* @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.
|
2353
|
-
*/
|
2354
2971
|
ParticipantsSubIdErrorByTypeAndID: {
|
2355
2972
|
parameters: {
|
2973
|
+
query?: never;
|
2356
2974
|
header: {
|
2975
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
2976
|
+
*
|
2977
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2357
2978
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2979
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2358
2980
|
"Content-Type": components["parameters"]["Content-Type"];
|
2981
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2359
2982
|
Date: components["parameters"]["Date"];
|
2983
|
+
/** @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.
|
2984
|
+
*
|
2985
|
+
* **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`. */
|
2360
2986
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2987
|
+
/** @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`). */
|
2361
2988
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2989
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2362
2990
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2991
|
+
/** @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. */
|
2363
2992
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2993
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2364
2994
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2995
|
+
/** @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). */
|
2365
2996
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2997
|
+
/** @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). */
|
2366
2998
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2367
2999
|
};
|
2368
3000
|
path: {
|
3001
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2369
3002
|
Type: components["parameters"]["Type"];
|
3003
|
+
/** @description The identifier value. */
|
2370
3004
|
ID: components["parameters"]["ID"];
|
3005
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2371
3006
|
SubId: components["parameters"]["SubId"];
|
2372
3007
|
};
|
3008
|
+
cookie?: never;
|
2373
3009
|
};
|
2374
3010
|
/** @description Details of the error returned. */
|
2375
3011
|
requestBody: {
|
@@ -2389,25 +3025,39 @@ export interface operations {
|
|
2389
3025
|
503: components["responses"]["503"];
|
2390
3026
|
};
|
2391
3027
|
};
|
2392
|
-
/**
|
2393
|
-
* Create bulk participant information
|
2394
|
-
* @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.
|
2395
|
-
*/
|
2396
3028
|
Participants1: {
|
2397
3029
|
parameters: {
|
3030
|
+
query?: never;
|
2398
3031
|
header: {
|
3032
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2399
3033
|
Accept: components["parameters"]["Accept"];
|
3034
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3035
|
+
*
|
3036
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2400
3037
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3038
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2401
3039
|
"Content-Type": components["parameters"]["Content-Type"];
|
3040
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2402
3041
|
Date: components["parameters"]["Date"];
|
3042
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
3043
|
+
*
|
3044
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2403
3045
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3046
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2404
3047
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3048
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2405
3049
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3050
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2406
3051
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3052
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2407
3053
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3054
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2408
3055
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3056
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2409
3057
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2410
3058
|
};
|
3059
|
+
path?: never;
|
3060
|
+
cookie?: never;
|
2411
3061
|
};
|
2412
3062
|
/** @description Participant information to be created. */
|
2413
3063
|
requestBody: {
|
@@ -2427,27 +3077,40 @@ export interface operations {
|
|
2427
3077
|
503: components["responses"]["503"];
|
2428
3078
|
};
|
2429
3079
|
};
|
2430
|
-
/**
|
2431
|
-
* Return bulk participant information
|
2432
|
-
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
2433
|
-
*/
|
2434
3080
|
putParticipantsByID: {
|
2435
3081
|
parameters: {
|
3082
|
+
query?: never;
|
2436
3083
|
header: {
|
3084
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3085
|
+
*
|
3086
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2437
3087
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3088
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2438
3089
|
"Content-Type": components["parameters"]["Content-Type"];
|
3090
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2439
3091
|
Date: components["parameters"]["Date"];
|
3092
|
+
/** @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.
|
3093
|
+
*
|
3094
|
+
* **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`. */
|
2440
3095
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3096
|
+
/** @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`). */
|
2441
3097
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3098
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2442
3099
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3100
|
+
/** @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. */
|
2443
3101
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3102
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2444
3103
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3104
|
+
/** @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). */
|
2445
3105
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3106
|
+
/** @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). */
|
2446
3107
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2447
3108
|
};
|
2448
3109
|
path: {
|
3110
|
+
/** @description The identifier value. */
|
2449
3111
|
ID: components["parameters"]["ID"];
|
2450
3112
|
};
|
3113
|
+
cookie?: never;
|
2451
3114
|
};
|
2452
3115
|
/** @description Participant information returned. */
|
2453
3116
|
requestBody: {
|
@@ -2467,27 +3130,40 @@ export interface operations {
|
|
2467
3130
|
503: components["responses"]["503"];
|
2468
3131
|
};
|
2469
3132
|
};
|
2470
|
-
/**
|
2471
|
-
* Return bulk participant information error
|
2472
|
-
* @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.
|
2473
|
-
*/
|
2474
3133
|
ParticipantsByIDAndError: {
|
2475
3134
|
parameters: {
|
3135
|
+
query?: never;
|
2476
3136
|
header: {
|
3137
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3138
|
+
*
|
3139
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2477
3140
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3141
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2478
3142
|
"Content-Type": components["parameters"]["Content-Type"];
|
3143
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2479
3144
|
Date: components["parameters"]["Date"];
|
3145
|
+
/** @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.
|
3146
|
+
*
|
3147
|
+
* **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`. */
|
2480
3148
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3149
|
+
/** @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`). */
|
2481
3150
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3151
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2482
3152
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3153
|
+
/** @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. */
|
2483
3154
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3155
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2484
3156
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3157
|
+
/** @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). */
|
2485
3158
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3159
|
+
/** @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). */
|
2486
3160
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2487
3161
|
};
|
2488
3162
|
path: {
|
3163
|
+
/** @description The identifier value. */
|
2489
3164
|
ID: components["parameters"]["ID"];
|
2490
3165
|
};
|
3166
|
+
cookie?: never;
|
2491
3167
|
};
|
2492
3168
|
/** @description Details of the error returned. */
|
2493
3169
|
requestBody: {
|
@@ -2507,29 +3183,42 @@ export interface operations {
|
|
2507
3183
|
503: components["responses"]["503"];
|
2508
3184
|
};
|
2509
3185
|
};
|
2510
|
-
/**
|
2511
|
-
* Look up party information
|
2512
|
-
* @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`).
|
2513
|
-
*/
|
2514
3186
|
PartiesByTypeAndID: {
|
2515
3187
|
parameters: {
|
3188
|
+
query?: never;
|
2516
3189
|
header: {
|
3190
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2517
3191
|
"Content-Type": components["parameters"]["Content-Type"];
|
3192
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2518
3193
|
Date: components["parameters"]["Date"];
|
3194
|
+
/** @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.
|
3195
|
+
*
|
3196
|
+
* **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`. */
|
2519
3197
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3198
|
+
/** @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`). */
|
2520
3199
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3200
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2521
3201
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3202
|
+
/** @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. */
|
2522
3203
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3204
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2523
3205
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3206
|
+
/** @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). */
|
2524
3207
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3208
|
+
/** @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). */
|
2525
3209
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3210
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2526
3211
|
Accept: components["parameters"]["Accept"];
|
2527
3212
|
};
|
2528
3213
|
path: {
|
3214
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2529
3215
|
Type: components["parameters"]["Type"];
|
3216
|
+
/** @description The identifier value. */
|
2530
3217
|
ID: components["parameters"]["ID"];
|
2531
3218
|
};
|
3219
|
+
cookie?: never;
|
2532
3220
|
};
|
3221
|
+
requestBody?: never;
|
2533
3222
|
responses: {
|
2534
3223
|
202: components["responses"]["202"];
|
2535
3224
|
400: components["responses"]["400"];
|
@@ -2542,28 +3231,42 @@ export interface operations {
|
|
2542
3231
|
503: components["responses"]["503"];
|
2543
3232
|
};
|
2544
3233
|
};
|
2545
|
-
/**
|
2546
|
-
* Return party information
|
2547
|
-
* @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.
|
2548
|
-
*/
|
2549
3234
|
PartiesByTypeAndID2: {
|
2550
3235
|
parameters: {
|
3236
|
+
query?: never;
|
2551
3237
|
header: {
|
3238
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2552
3239
|
"Content-Type": components["parameters"]["Content-Type"];
|
3240
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2553
3241
|
Date: components["parameters"]["Date"];
|
3242
|
+
/** @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.
|
3243
|
+
*
|
3244
|
+
* **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`. */
|
2554
3245
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3246
|
+
/** @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`). */
|
2555
3247
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3248
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2556
3249
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3250
|
+
/** @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. */
|
2557
3251
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3252
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2558
3253
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3254
|
+
/** @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). */
|
2559
3255
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3256
|
+
/** @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). */
|
2560
3257
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3258
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3259
|
+
*
|
3260
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2561
3261
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2562
3262
|
};
|
2563
3263
|
path: {
|
3264
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2564
3265
|
Type: components["parameters"]["Type"];
|
3266
|
+
/** @description The identifier value. */
|
2565
3267
|
ID: components["parameters"]["ID"];
|
2566
3268
|
};
|
3269
|
+
cookie?: never;
|
2567
3270
|
};
|
2568
3271
|
/** @description Party information returned. */
|
2569
3272
|
requestBody: {
|
@@ -2583,28 +3286,42 @@ export interface operations {
|
|
2583
3286
|
503: components["responses"]["503"];
|
2584
3287
|
};
|
2585
3288
|
};
|
2586
|
-
/**
|
2587
|
-
* Return party information error
|
2588
|
-
* @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.
|
2589
|
-
*/
|
2590
3289
|
PartiesErrorByTypeAndID: {
|
2591
3290
|
parameters: {
|
3291
|
+
query?: never;
|
2592
3292
|
header: {
|
3293
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3294
|
+
*
|
3295
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2593
3296
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3297
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2594
3298
|
"Content-Type": components["parameters"]["Content-Type"];
|
3299
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2595
3300
|
Date: components["parameters"]["Date"];
|
3301
|
+
/** @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.
|
3302
|
+
*
|
3303
|
+
* **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`. */
|
2596
3304
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3305
|
+
/** @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`). */
|
2597
3306
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3307
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2598
3308
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3309
|
+
/** @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. */
|
2599
3310
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3311
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2600
3312
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3313
|
+
/** @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). */
|
2601
3314
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3315
|
+
/** @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). */
|
2602
3316
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2603
3317
|
};
|
2604
3318
|
path: {
|
3319
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2605
3320
|
Type: components["parameters"]["Type"];
|
3321
|
+
/** @description The identifier value. */
|
2606
3322
|
ID: components["parameters"]["ID"];
|
2607
3323
|
};
|
3324
|
+
cookie?: never;
|
2608
3325
|
};
|
2609
3326
|
/** @description Details of the error returned. */
|
2610
3327
|
requestBody: {
|
@@ -2624,30 +3341,44 @@ export interface operations {
|
|
2624
3341
|
503: components["responses"]["503"];
|
2625
3342
|
};
|
2626
3343
|
};
|
2627
|
-
/**
|
2628
|
-
* Look up party information
|
2629
|
-
* @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`).
|
2630
|
-
*/
|
2631
3344
|
PartiesSubIdByTypeAndID: {
|
2632
3345
|
parameters: {
|
3346
|
+
query?: never;
|
2633
3347
|
header: {
|
3348
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2634
3349
|
"Content-Type": components["parameters"]["Content-Type"];
|
3350
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2635
3351
|
Date: components["parameters"]["Date"];
|
3352
|
+
/** @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.
|
3353
|
+
*
|
3354
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
2636
3355
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3356
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
2637
3357
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3358
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2638
3359
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3360
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
2639
3361
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3362
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2640
3363
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3364
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2641
3365
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3366
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
2642
3367
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3368
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2643
3369
|
Accept: components["parameters"]["Accept"];
|
2644
3370
|
};
|
2645
3371
|
path: {
|
3372
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2646
3373
|
Type: components["parameters"]["Type"];
|
3374
|
+
/** @description The identifier value. */
|
2647
3375
|
ID: components["parameters"]["ID"];
|
3376
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2648
3377
|
SubId: components["parameters"]["SubId"];
|
2649
3378
|
};
|
3379
|
+
cookie?: never;
|
2650
3380
|
};
|
3381
|
+
requestBody?: never;
|
2651
3382
|
responses: {
|
2652
3383
|
202: components["responses"]["202"];
|
2653
3384
|
400: components["responses"]["400"];
|
@@ -2660,29 +3391,44 @@ export interface operations {
|
|
2660
3391
|
503: components["responses"]["503"];
|
2661
3392
|
};
|
2662
3393
|
};
|
2663
|
-
/**
|
2664
|
-
* Return party information
|
2665
|
-
* @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.
|
2666
|
-
*/
|
2667
3394
|
PartiesSubIdByTypeAndIDPut: {
|
2668
3395
|
parameters: {
|
3396
|
+
query?: never;
|
2669
3397
|
header: {
|
3398
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2670
3399
|
"Content-Type": components["parameters"]["Content-Type"];
|
3400
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2671
3401
|
Date: components["parameters"]["Date"];
|
3402
|
+
/** @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.
|
3403
|
+
*
|
3404
|
+
* **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`. */
|
2672
3405
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3406
|
+
/** @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`). */
|
2673
3407
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3408
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2674
3409
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3410
|
+
/** @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. */
|
2675
3411
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3412
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2676
3413
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3414
|
+
/** @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). */
|
2677
3415
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3416
|
+
/** @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). */
|
2678
3417
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3418
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3419
|
+
*
|
3420
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2679
3421
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2680
3422
|
};
|
2681
3423
|
path: {
|
3424
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2682
3425
|
Type: components["parameters"]["Type"];
|
3426
|
+
/** @description The identifier value. */
|
2683
3427
|
ID: components["parameters"]["ID"];
|
3428
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2684
3429
|
SubId: components["parameters"]["SubId"];
|
2685
3430
|
};
|
3431
|
+
cookie?: never;
|
2686
3432
|
};
|
2687
3433
|
/** @description Party information returned. */
|
2688
3434
|
requestBody: {
|
@@ -2702,29 +3448,44 @@ export interface operations {
|
|
2702
3448
|
503: components["responses"]["503"];
|
2703
3449
|
};
|
2704
3450
|
};
|
2705
|
-
/**
|
2706
|
-
* Return party information error
|
2707
|
-
* @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.
|
2708
|
-
*/
|
2709
3451
|
PartiesSubIdErrorByTypeAndID: {
|
2710
3452
|
parameters: {
|
3453
|
+
query?: never;
|
2711
3454
|
header: {
|
3455
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3456
|
+
*
|
3457
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2712
3458
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3459
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2713
3460
|
"Content-Type": components["parameters"]["Content-Type"];
|
3461
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2714
3462
|
Date: components["parameters"]["Date"];
|
3463
|
+
/** @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.
|
3464
|
+
*
|
3465
|
+
* **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`. */
|
2715
3466
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3467
|
+
/** @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`). */
|
2716
3468
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3469
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2717
3470
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3471
|
+
/** @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. */
|
2718
3472
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3473
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2719
3474
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3475
|
+
/** @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). */
|
2720
3476
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3477
|
+
/** @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). */
|
2721
3478
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2722
3479
|
};
|
2723
3480
|
path: {
|
3481
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
2724
3482
|
Type: components["parameters"]["Type"];
|
3483
|
+
/** @description The identifier value. */
|
2725
3484
|
ID: components["parameters"]["ID"];
|
3485
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
2726
3486
|
SubId: components["parameters"]["SubId"];
|
2727
3487
|
};
|
3488
|
+
cookie?: never;
|
2728
3489
|
};
|
2729
3490
|
/** @description Details of the error returned. */
|
2730
3491
|
requestBody: {
|
@@ -2744,25 +3505,39 @@ export interface operations {
|
|
2744
3505
|
503: components["responses"]["503"];
|
2745
3506
|
};
|
2746
3507
|
};
|
2747
|
-
/**
|
2748
|
-
* Perform transaction request
|
2749
|
-
* @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
|
2750
|
-
*/
|
2751
3508
|
TransactionRequests: {
|
2752
3509
|
parameters: {
|
3510
|
+
query?: never;
|
2753
3511
|
header: {
|
3512
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2754
3513
|
Accept: components["parameters"]["Accept"];
|
3514
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3515
|
+
*
|
3516
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2755
3517
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3518
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2756
3519
|
"Content-Type": components["parameters"]["Content-Type"];
|
3520
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2757
3521
|
Date: components["parameters"]["Date"];
|
3522
|
+
/** @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.
|
3523
|
+
*
|
3524
|
+
* **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`. */
|
2758
3525
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3526
|
+
/** @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`). */
|
2759
3527
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3528
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2760
3529
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3530
|
+
/** @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. */
|
2761
3531
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3532
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2762
3533
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3534
|
+
/** @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). */
|
2763
3535
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3536
|
+
/** @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). */
|
2764
3537
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2765
3538
|
};
|
3539
|
+
path?: never;
|
3540
|
+
cookie?: never;
|
2766
3541
|
};
|
2767
3542
|
/** @description Transaction request to be created. */
|
2768
3543
|
requestBody: {
|
@@ -2782,28 +3557,40 @@ export interface operations {
|
|
2782
3557
|
503: components["responses"]["503"];
|
2783
3558
|
};
|
2784
3559
|
};
|
2785
|
-
/**
|
2786
|
-
* Retrieve transaction request information
|
2787
|
-
* @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.
|
2788
|
-
*/
|
2789
3560
|
TransactionRequestsByID: {
|
2790
3561
|
parameters: {
|
3562
|
+
query?: never;
|
2791
3563
|
header: {
|
3564
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2792
3565
|
"Content-Type": components["parameters"]["Content-Type"];
|
3566
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2793
3567
|
Date: components["parameters"]["Date"];
|
3568
|
+
/** @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.
|
3569
|
+
*
|
3570
|
+
* **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`. */
|
2794
3571
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3572
|
+
/** @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`). */
|
2795
3573
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3574
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2796
3575
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3576
|
+
/** @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. */
|
2797
3577
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3578
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2798
3579
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3580
|
+
/** @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). */
|
2799
3581
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3582
|
+
/** @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). */
|
2800
3583
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3584
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2801
3585
|
Accept: components["parameters"]["Accept"];
|
2802
3586
|
};
|
2803
3587
|
path: {
|
3588
|
+
/** @description The identifier value. */
|
2804
3589
|
ID: components["parameters"]["ID"];
|
2805
3590
|
};
|
3591
|
+
cookie?: never;
|
2806
3592
|
};
|
3593
|
+
requestBody?: never;
|
2807
3594
|
responses: {
|
2808
3595
|
202: components["responses"]["202"];
|
2809
3596
|
400: components["responses"]["400"];
|
@@ -2816,27 +3603,40 @@ export interface operations {
|
|
2816
3603
|
503: components["responses"]["503"];
|
2817
3604
|
};
|
2818
3605
|
};
|
2819
|
-
/**
|
2820
|
-
* Return transaction request information
|
2821
|
-
* @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}`.
|
2822
|
-
*/
|
2823
3606
|
TransactionRequestsByIDPut: {
|
2824
3607
|
parameters: {
|
3608
|
+
query?: never;
|
2825
3609
|
header: {
|
3610
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2826
3611
|
"Content-Type": components["parameters"]["Content-Type"];
|
3612
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2827
3613
|
Date: components["parameters"]["Date"];
|
3614
|
+
/** @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.
|
3615
|
+
*
|
3616
|
+
* **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`. */
|
2828
3617
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3618
|
+
/** @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`). */
|
2829
3619
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3620
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2830
3621
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3622
|
+
/** @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. */
|
2831
3623
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3624
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2832
3625
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3626
|
+
/** @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). */
|
2833
3627
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3628
|
+
/** @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). */
|
2834
3629
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3630
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3631
|
+
*
|
3632
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2835
3633
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2836
3634
|
};
|
2837
3635
|
path: {
|
3636
|
+
/** @description The identifier value. */
|
2838
3637
|
ID: components["parameters"]["ID"];
|
2839
3638
|
};
|
3639
|
+
cookie?: never;
|
2840
3640
|
};
|
2841
3641
|
/** @description Transaction request information returned. */
|
2842
3642
|
requestBody: {
|
@@ -2856,27 +3656,40 @@ export interface operations {
|
|
2856
3656
|
503: components["responses"]["503"];
|
2857
3657
|
};
|
2858
3658
|
};
|
2859
|
-
/**
|
2860
|
-
* Return transaction request information error
|
2861
|
-
* @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}`.
|
2862
|
-
*/
|
2863
3659
|
TransactionRequestsErrorByID: {
|
2864
3660
|
parameters: {
|
3661
|
+
query?: never;
|
2865
3662
|
header: {
|
3663
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3664
|
+
*
|
3665
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2866
3666
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3667
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2867
3668
|
"Content-Type": components["parameters"]["Content-Type"];
|
3669
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2868
3670
|
Date: components["parameters"]["Date"];
|
3671
|
+
/** @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.
|
3672
|
+
*
|
3673
|
+
* **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`. */
|
2869
3674
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3675
|
+
/** @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`). */
|
2870
3676
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3677
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2871
3678
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3679
|
+
/** @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. */
|
2872
3680
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3681
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2873
3682
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3683
|
+
/** @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). */
|
2874
3684
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3685
|
+
/** @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). */
|
2875
3686
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2876
3687
|
};
|
2877
3688
|
path: {
|
3689
|
+
/** @description The identifier value. */
|
2878
3690
|
ID: components["parameters"]["ID"];
|
2879
3691
|
};
|
3692
|
+
cookie?: never;
|
2880
3693
|
};
|
2881
3694
|
/** @description Details of the error returned. */
|
2882
3695
|
requestBody: {
|
@@ -2896,25 +3709,39 @@ export interface operations {
|
|
2896
3709
|
503: components["responses"]["503"];
|
2897
3710
|
};
|
2898
3711
|
};
|
2899
|
-
/**
|
2900
|
-
* Calculate quote
|
2901
|
-
* @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
|
2902
|
-
*/
|
2903
3712
|
Quotes: {
|
2904
3713
|
parameters: {
|
3714
|
+
query?: never;
|
2905
3715
|
header: {
|
3716
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2906
3717
|
Accept: components["parameters"]["Accept"];
|
3718
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3719
|
+
*
|
3720
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2907
3721
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3722
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2908
3723
|
"Content-Type": components["parameters"]["Content-Type"];
|
3724
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2909
3725
|
Date: components["parameters"]["Date"];
|
3726
|
+
/** @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.
|
3727
|
+
*
|
3728
|
+
* **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`. */
|
2910
3729
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3730
|
+
/** @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`). */
|
2911
3731
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3732
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2912
3733
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3734
|
+
/** @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. */
|
2913
3735
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3736
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2914
3737
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3738
|
+
/** @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). */
|
2915
3739
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3740
|
+
/** @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). */
|
2916
3741
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2917
3742
|
};
|
3743
|
+
path?: never;
|
3744
|
+
cookie?: never;
|
2918
3745
|
};
|
2919
3746
|
/** @description Details of the quote to be created. */
|
2920
3747
|
requestBody: {
|
@@ -2934,28 +3761,40 @@ export interface operations {
|
|
2934
3761
|
503: components["responses"]["503"];
|
2935
3762
|
};
|
2936
3763
|
};
|
2937
|
-
/**
|
2938
|
-
* Retrieve quote information
|
2939
|
-
* @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.
|
2940
|
-
*/
|
2941
3764
|
QuotesByID: {
|
2942
3765
|
parameters: {
|
3766
|
+
query?: never;
|
2943
3767
|
header: {
|
3768
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2944
3769
|
"Content-Type": components["parameters"]["Content-Type"];
|
3770
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2945
3771
|
Date: components["parameters"]["Date"];
|
3772
|
+
/** @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.
|
3773
|
+
*
|
3774
|
+
* **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`. */
|
2946
3775
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3776
|
+
/** @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`). */
|
2947
3777
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3778
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2948
3779
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3780
|
+
/** @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. */
|
2949
3781
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3782
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2950
3783
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3784
|
+
/** @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). */
|
2951
3785
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3786
|
+
/** @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). */
|
2952
3787
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3788
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
2953
3789
|
Accept: components["parameters"]["Accept"];
|
2954
3790
|
};
|
2955
3791
|
path: {
|
3792
|
+
/** @description The identifier value. */
|
2956
3793
|
ID: components["parameters"]["ID"];
|
2957
3794
|
};
|
3795
|
+
cookie?: never;
|
2958
3796
|
};
|
3797
|
+
requestBody?: never;
|
2959
3798
|
responses: {
|
2960
3799
|
202: components["responses"]["202"];
|
2961
3800
|
400: components["responses"]["400"];
|
@@ -2968,27 +3807,40 @@ export interface operations {
|
|
2968
3807
|
503: components["responses"]["503"];
|
2969
3808
|
};
|
2970
3809
|
};
|
2971
|
-
/**
|
2972
|
-
* Return quote information
|
2973
|
-
* @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.
|
2974
|
-
*/
|
2975
3810
|
QuotesByID1: {
|
2976
3811
|
parameters: {
|
3812
|
+
query?: never;
|
2977
3813
|
header: {
|
3814
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
2978
3815
|
"Content-Type": components["parameters"]["Content-Type"];
|
3816
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
2979
3817
|
Date: components["parameters"]["Date"];
|
3818
|
+
/** @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.
|
3819
|
+
*
|
3820
|
+
* **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`. */
|
2980
3821
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3822
|
+
/** @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`). */
|
2981
3823
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3824
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
2982
3825
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3826
|
+
/** @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. */
|
2983
3827
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3828
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
2984
3829
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3830
|
+
/** @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). */
|
2985
3831
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3832
|
+
/** @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). */
|
2986
3833
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3834
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3835
|
+
*
|
3836
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
2987
3837
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
2988
3838
|
};
|
2989
3839
|
path: {
|
3840
|
+
/** @description The identifier value. */
|
2990
3841
|
ID: components["parameters"]["ID"];
|
2991
3842
|
};
|
3843
|
+
cookie?: never;
|
2992
3844
|
};
|
2993
3845
|
/** @description Quote information returned. */
|
2994
3846
|
requestBody: {
|
@@ -3008,27 +3860,40 @@ export interface operations {
|
|
3008
3860
|
503: components["responses"]["503"];
|
3009
3861
|
};
|
3010
3862
|
};
|
3011
|
-
/**
|
3012
|
-
* Return quote information error
|
3013
|
-
* @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.
|
3014
|
-
*/
|
3015
3863
|
QuotesByIDAndError: {
|
3016
3864
|
parameters: {
|
3865
|
+
query?: never;
|
3017
3866
|
header: {
|
3867
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3868
|
+
*
|
3869
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3018
3870
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3871
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3019
3872
|
"Content-Type": components["parameters"]["Content-Type"];
|
3873
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3020
3874
|
Date: components["parameters"]["Date"];
|
3875
|
+
/** @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.
|
3876
|
+
*
|
3877
|
+
* **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`. */
|
3021
3878
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3879
|
+
/** @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`). */
|
3022
3880
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3881
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3023
3882
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3883
|
+
/** @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. */
|
3024
3884
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3885
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3025
3886
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3887
|
+
/** @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). */
|
3026
3888
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3889
|
+
/** @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). */
|
3027
3890
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3028
3891
|
};
|
3029
3892
|
path: {
|
3893
|
+
/** @description The identifier value. */
|
3030
3894
|
ID: components["parameters"]["ID"];
|
3031
3895
|
};
|
3896
|
+
cookie?: never;
|
3032
3897
|
};
|
3033
3898
|
/** @description Details of the error returned. */
|
3034
3899
|
requestBody: {
|
@@ -3048,40 +3913,40 @@ export interface operations {
|
|
3048
3913
|
503: components["responses"]["503"];
|
3049
3914
|
};
|
3050
3915
|
};
|
3051
|
-
/**
|
3052
|
-
* Perform authorization
|
3053
|
-
* @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*:*
|
3054
|
-
*
|
3055
|
-
* - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
|
3056
|
-
*
|
3057
|
-
* - `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.
|
3058
|
-
*
|
3059
|
-
* - `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`.
|
3060
|
-
*
|
3061
|
-
* - `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`.
|
3062
|
-
*
|
3063
|
-
* The following is an example URI containing all the required key-value pairs in the query string*:*
|
3064
|
-
*
|
3065
|
-
* `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD`
|
3066
|
-
*/
|
3067
3916
|
AuthorizationsByIDGet: {
|
3068
3917
|
parameters: {
|
3918
|
+
query?: never;
|
3069
3919
|
header: {
|
3920
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3070
3921
|
"Content-Type": components["parameters"]["Content-Type"];
|
3922
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3071
3923
|
Date: components["parameters"]["Date"];
|
3924
|
+
/** @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.
|
3925
|
+
*
|
3926
|
+
* **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`. */
|
3072
3927
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3928
|
+
/** @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`). */
|
3073
3929
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3930
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3074
3931
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3932
|
+
/** @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. */
|
3075
3933
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3934
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3076
3935
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3936
|
+
/** @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). */
|
3077
3937
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3938
|
+
/** @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). */
|
3078
3939
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3940
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3079
3941
|
Accept: components["parameters"]["Accept"];
|
3080
3942
|
};
|
3081
3943
|
path: {
|
3944
|
+
/** @description The identifier value. */
|
3082
3945
|
ID: components["parameters"]["ID"];
|
3083
3946
|
};
|
3947
|
+
cookie?: never;
|
3084
3948
|
};
|
3949
|
+
requestBody?: never;
|
3085
3950
|
responses: {
|
3086
3951
|
202: components["responses"]["202"];
|
3087
3952
|
400: components["responses"]["400"];
|
@@ -3094,27 +3959,40 @@ export interface operations {
|
|
3094
3959
|
503: components["responses"]["503"];
|
3095
3960
|
};
|
3096
3961
|
};
|
3097
|
-
/**
|
3098
|
-
* Return authorization result
|
3099
|
-
* @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.
|
3100
|
-
*/
|
3101
3962
|
AuthorizationsByIDPut: {
|
3102
3963
|
parameters: {
|
3964
|
+
query?: never;
|
3103
3965
|
header: {
|
3966
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3104
3967
|
"Content-Type": components["parameters"]["Content-Type"];
|
3968
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3105
3969
|
Date: components["parameters"]["Date"];
|
3970
|
+
/** @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.
|
3971
|
+
*
|
3972
|
+
* **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`. */
|
3106
3973
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3974
|
+
/** @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`). */
|
3107
3975
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3976
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3108
3977
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3978
|
+
/** @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. */
|
3109
3979
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3980
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3110
3981
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3982
|
+
/** @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). */
|
3111
3983
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3984
|
+
/** @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). */
|
3112
3985
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3986
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
3987
|
+
*
|
3988
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3113
3989
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3114
3990
|
};
|
3115
3991
|
path: {
|
3992
|
+
/** @description The identifier value. */
|
3116
3993
|
ID: components["parameters"]["ID"];
|
3117
3994
|
};
|
3995
|
+
cookie?: never;
|
3118
3996
|
};
|
3119
3997
|
/** @description Authorization result returned. */
|
3120
3998
|
requestBody: {
|
@@ -3134,27 +4012,40 @@ export interface operations {
|
|
3134
4012
|
503: components["responses"]["503"];
|
3135
4013
|
};
|
3136
4014
|
};
|
3137
|
-
/**
|
3138
|
-
* Return authorization error
|
3139
|
-
* @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}`.
|
3140
|
-
*/
|
3141
4015
|
AuthorizationsByIDAndError: {
|
3142
4016
|
parameters: {
|
4017
|
+
query?: never;
|
3143
4018
|
header: {
|
4019
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4020
|
+
*
|
4021
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3144
4022
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4023
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3145
4024
|
"Content-Type": components["parameters"]["Content-Type"];
|
4025
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3146
4026
|
Date: components["parameters"]["Date"];
|
4027
|
+
/** @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.
|
4028
|
+
*
|
4029
|
+
* **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`. */
|
3147
4030
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4031
|
+
/** @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`). */
|
3148
4032
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4033
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3149
4034
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4035
|
+
/** @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. */
|
3150
4036
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4037
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3151
4038
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4039
|
+
/** @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). */
|
3152
4040
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4041
|
+
/** @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). */
|
3153
4042
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3154
4043
|
};
|
3155
4044
|
path: {
|
4045
|
+
/** @description The identifier value. */
|
3156
4046
|
ID: components["parameters"]["ID"];
|
3157
4047
|
};
|
4048
|
+
cookie?: never;
|
3158
4049
|
};
|
3159
4050
|
/** @description Details of the error returned. */
|
3160
4051
|
requestBody: {
|
@@ -3174,25 +4065,39 @@ export interface operations {
|
|
3174
4065
|
503: components["responses"]["503"];
|
3175
4066
|
};
|
3176
4067
|
};
|
3177
|
-
/**
|
3178
|
-
* Perform transfer
|
3179
|
-
* @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.
|
3180
|
-
*/
|
3181
4068
|
transfers: {
|
3182
4069
|
parameters: {
|
4070
|
+
query?: never;
|
3183
4071
|
header: {
|
4072
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3184
4073
|
Accept: components["parameters"]["Accept"];
|
4074
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4075
|
+
*
|
4076
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3185
4077
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4078
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3186
4079
|
"Content-Type": components["parameters"]["Content-Type"];
|
4080
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3187
4081
|
Date: components["parameters"]["Date"];
|
4082
|
+
/** @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.
|
4083
|
+
*
|
4084
|
+
* **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`. */
|
3188
4085
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4086
|
+
/** @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`). */
|
3189
4087
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4088
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3190
4089
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4090
|
+
/** @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. */
|
3191
4091
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4092
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3192
4093
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4094
|
+
/** @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). */
|
3193
4095
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4096
|
+
/** @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). */
|
3194
4097
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3195
4098
|
};
|
4099
|
+
path?: never;
|
4100
|
+
cookie?: never;
|
3196
4101
|
};
|
3197
4102
|
/** @description Details of the transfer to be created. */
|
3198
4103
|
requestBody: {
|
@@ -3212,28 +4117,40 @@ export interface operations {
|
|
3212
4117
|
503: components["responses"]["503"];
|
3213
4118
|
};
|
3214
4119
|
};
|
3215
|
-
/**
|
3216
|
-
* Retrieve transfer information
|
3217
|
-
* @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.
|
3218
|
-
*/
|
3219
4120
|
TransfersByIDGet: {
|
3220
4121
|
parameters: {
|
4122
|
+
query?: never;
|
3221
4123
|
header: {
|
4124
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3222
4125
|
"Content-Type": components["parameters"]["Content-Type"];
|
4126
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3223
4127
|
Date: components["parameters"]["Date"];
|
4128
|
+
/** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4129
|
+
*
|
4130
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */
|
3224
4131
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4132
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
3225
4133
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4134
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3226
4135
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4136
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
3227
4137
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4138
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3228
4139
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4140
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3229
4141
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4142
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
3230
4143
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4144
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3231
4145
|
Accept: components["parameters"]["Accept"];
|
3232
4146
|
};
|
3233
4147
|
path: {
|
4148
|
+
/** @description The identifier value. */
|
3234
4149
|
ID: components["parameters"]["ID"];
|
3235
4150
|
};
|
4151
|
+
cookie?: never;
|
3236
4152
|
};
|
4153
|
+
requestBody?: never;
|
3237
4154
|
responses: {
|
3238
4155
|
202: components["responses"]["202"];
|
3239
4156
|
400: components["responses"]["400"];
|
@@ -3246,27 +4163,40 @@ export interface operations {
|
|
3246
4163
|
503: components["responses"]["503"];
|
3247
4164
|
};
|
3248
4165
|
};
|
3249
|
-
/**
|
3250
|
-
* Return transfer information
|
3251
|
-
* @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.
|
3252
|
-
*/
|
3253
4166
|
TransfersByIDPut: {
|
3254
4167
|
parameters: {
|
4168
|
+
query?: never;
|
3255
4169
|
header: {
|
4170
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3256
4171
|
"Content-Type": components["parameters"]["Content-Type"];
|
4172
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3257
4173
|
Date: components["parameters"]["Date"];
|
4174
|
+
/** @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.
|
4175
|
+
*
|
4176
|
+
* **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`. */
|
3258
4177
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4178
|
+
/** @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`). */
|
3259
4179
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4180
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3260
4181
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4182
|
+
/** @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. */
|
3261
4183
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4184
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3262
4185
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4186
|
+
/** @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). */
|
3263
4187
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4188
|
+
/** @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). */
|
3264
4189
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4190
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4191
|
+
*
|
4192
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3265
4193
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3266
4194
|
};
|
3267
4195
|
path: {
|
4196
|
+
/** @description The identifier value. */
|
3268
4197
|
ID: components["parameters"]["ID"];
|
3269
4198
|
};
|
4199
|
+
cookie?: never;
|
3270
4200
|
};
|
3271
4201
|
/** @description Transfer information returned. */
|
3272
4202
|
requestBody: {
|
@@ -3286,27 +4216,40 @@ export interface operations {
|
|
3286
4216
|
503: components["responses"]["503"];
|
3287
4217
|
};
|
3288
4218
|
};
|
3289
|
-
/**
|
3290
|
-
* Return transfer information error
|
3291
|
-
* @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}`.
|
3292
|
-
*/
|
3293
4219
|
TransfersByIDAndError: {
|
3294
4220
|
parameters: {
|
4221
|
+
query?: never;
|
3295
4222
|
header: {
|
4223
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4224
|
+
*
|
4225
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3296
4226
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4227
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3297
4228
|
"Content-Type": components["parameters"]["Content-Type"];
|
4229
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3298
4230
|
Date: components["parameters"]["Date"];
|
4231
|
+
/** @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.
|
4232
|
+
*
|
4233
|
+
* **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`. */
|
3299
4234
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4235
|
+
/** @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`). */
|
3300
4236
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4237
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3301
4238
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4239
|
+
/** @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. */
|
3302
4240
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4241
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3303
4242
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4243
|
+
/** @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). */
|
3304
4244
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4245
|
+
/** @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). */
|
3305
4246
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3306
4247
|
};
|
3307
4248
|
path: {
|
4249
|
+
/** @description The identifier value. */
|
3308
4250
|
ID: components["parameters"]["ID"];
|
3309
4251
|
};
|
4252
|
+
cookie?: never;
|
3310
4253
|
};
|
3311
4254
|
/** @description Details of the error returned. */
|
3312
4255
|
requestBody: {
|
@@ -3326,28 +4269,40 @@ export interface operations {
|
|
3326
4269
|
503: components["responses"]["503"];
|
3327
4270
|
};
|
3328
4271
|
};
|
3329
|
-
/**
|
3330
|
-
* Retrieve transaction information
|
3331
|
-
* @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).
|
3332
|
-
*/
|
3333
4272
|
TransactionsByID: {
|
3334
4273
|
parameters: {
|
4274
|
+
query?: never;
|
3335
4275
|
header: {
|
4276
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3336
4277
|
"Content-Type": components["parameters"]["Content-Type"];
|
4278
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3337
4279
|
Date: components["parameters"]["Date"];
|
4280
|
+
/** @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.
|
4281
|
+
*
|
4282
|
+
* **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`. */
|
3338
4283
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4284
|
+
/** @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`). */
|
3339
4285
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4286
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3340
4287
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4288
|
+
/** @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. */
|
3341
4289
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4290
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3342
4291
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4292
|
+
/** @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). */
|
3343
4293
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4294
|
+
/** @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). */
|
3344
4295
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4296
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3345
4297
|
Accept: components["parameters"]["Accept"];
|
3346
4298
|
};
|
3347
4299
|
path: {
|
4300
|
+
/** @description The identifier value. */
|
3348
4301
|
ID: components["parameters"]["ID"];
|
3349
4302
|
};
|
4303
|
+
cookie?: never;
|
3350
4304
|
};
|
4305
|
+
requestBody?: never;
|
3351
4306
|
responses: {
|
3352
4307
|
202: components["responses"]["202"];
|
3353
4308
|
400: components["responses"]["400"];
|
@@ -3360,27 +4315,40 @@ export interface operations {
|
|
3360
4315
|
503: components["responses"]["503"];
|
3361
4316
|
};
|
3362
4317
|
};
|
3363
|
-
/**
|
3364
|
-
* Return transaction information
|
3365
|
-
* @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.
|
3366
|
-
*/
|
3367
4318
|
TransactionsByID1: {
|
3368
4319
|
parameters: {
|
4320
|
+
query?: never;
|
3369
4321
|
header: {
|
4322
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3370
4323
|
"Content-Type": components["parameters"]["Content-Type"];
|
4324
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3371
4325
|
Date: components["parameters"]["Date"];
|
4326
|
+
/** @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.
|
4327
|
+
*
|
4328
|
+
* **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`. */
|
3372
4329
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4330
|
+
/** @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`). */
|
3373
4331
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4332
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3374
4333
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4334
|
+
/** @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. */
|
3375
4335
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4336
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3376
4337
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4338
|
+
/** @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). */
|
3377
4339
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4340
|
+
/** @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). */
|
3378
4341
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4342
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4343
|
+
*
|
4344
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3379
4345
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3380
4346
|
};
|
3381
4347
|
path: {
|
4348
|
+
/** @description The identifier value. */
|
3382
4349
|
ID: components["parameters"]["ID"];
|
3383
4350
|
};
|
4351
|
+
cookie?: never;
|
3384
4352
|
};
|
3385
4353
|
/** @description Transaction information returned. */
|
3386
4354
|
requestBody: {
|
@@ -3400,27 +4368,40 @@ export interface operations {
|
|
3400
4368
|
503: components["responses"]["503"];
|
3401
4369
|
};
|
3402
4370
|
};
|
3403
|
-
/**
|
3404
|
-
* Return transaction information error
|
3405
|
-
* @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.
|
3406
|
-
*/
|
3407
4371
|
TransactionsErrorByID: {
|
3408
4372
|
parameters: {
|
4373
|
+
query?: never;
|
3409
4374
|
header: {
|
4375
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4376
|
+
*
|
4377
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3410
4378
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4379
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3411
4380
|
"Content-Type": components["parameters"]["Content-Type"];
|
4381
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3412
4382
|
Date: components["parameters"]["Date"];
|
4383
|
+
/** @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.
|
4384
|
+
*
|
4385
|
+
* **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`. */
|
3413
4386
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4387
|
+
/** @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`). */
|
3414
4388
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4389
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3415
4390
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4391
|
+
/** @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. */
|
3416
4392
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4393
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3417
4394
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4395
|
+
/** @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). */
|
3418
4396
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4397
|
+
/** @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). */
|
3419
4398
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3420
4399
|
};
|
3421
4400
|
path: {
|
4401
|
+
/** @description The identifier value. */
|
3422
4402
|
ID: components["parameters"]["ID"];
|
3423
4403
|
};
|
4404
|
+
cookie?: never;
|
3424
4405
|
};
|
3425
4406
|
/** @description Details of the error returned. */
|
3426
4407
|
requestBody: {
|
@@ -3440,25 +4421,39 @@ export interface operations {
|
|
3440
4421
|
503: components["responses"]["503"];
|
3441
4422
|
};
|
3442
4423
|
};
|
3443
|
-
/**
|
3444
|
-
* Calculate bulk quote
|
3445
|
-
* @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
|
3446
|
-
*/
|
3447
4424
|
BulkQuotes: {
|
3448
4425
|
parameters: {
|
4426
|
+
query?: never;
|
3449
4427
|
header: {
|
4428
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3450
4429
|
Accept: components["parameters"]["Accept"];
|
4430
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4431
|
+
*
|
4432
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3451
4433
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4434
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3452
4435
|
"Content-Type": components["parameters"]["Content-Type"];
|
4436
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3453
4437
|
Date: components["parameters"]["Date"];
|
4438
|
+
/** @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.
|
4439
|
+
*
|
4440
|
+
* **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`. */
|
3454
4441
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4442
|
+
/** @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`). */
|
3455
4443
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4444
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3456
4445
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4446
|
+
/** @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. */
|
3457
4447
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4448
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3458
4449
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4450
|
+
/** @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). */
|
3459
4451
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4452
|
+
/** @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). */
|
3460
4453
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3461
4454
|
};
|
4455
|
+
path?: never;
|
4456
|
+
cookie?: never;
|
3462
4457
|
};
|
3463
4458
|
/** @description Details of the bulk quote to be created. */
|
3464
4459
|
requestBody: {
|
@@ -3478,28 +4473,40 @@ export interface operations {
|
|
3478
4473
|
503: components["responses"]["503"];
|
3479
4474
|
};
|
3480
4475
|
};
|
3481
|
-
/**
|
3482
|
-
* Retrieve bulk quote information
|
3483
|
-
* @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.
|
3484
|
-
*/
|
3485
4476
|
BulkQuotesByID: {
|
3486
4477
|
parameters: {
|
4478
|
+
query?: never;
|
3487
4479
|
header: {
|
4480
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3488
4481
|
"Content-Type": components["parameters"]["Content-Type"];
|
4482
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3489
4483
|
Date: components["parameters"]["Date"];
|
4484
|
+
/** @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.
|
4485
|
+
*
|
4486
|
+
* **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`. */
|
3490
4487
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4488
|
+
/** @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`). */
|
3491
4489
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4490
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3492
4491
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4492
|
+
/** @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. */
|
3493
4493
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4494
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3494
4495
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4496
|
+
/** @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). */
|
3495
4497
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4498
|
+
/** @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). */
|
3496
4499
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4500
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3497
4501
|
Accept: components["parameters"]["Accept"];
|
3498
4502
|
};
|
3499
4503
|
path: {
|
4504
|
+
/** @description The identifier value. */
|
3500
4505
|
ID: components["parameters"]["ID"];
|
3501
4506
|
};
|
4507
|
+
cookie?: never;
|
3502
4508
|
};
|
4509
|
+
requestBody?: never;
|
3503
4510
|
responses: {
|
3504
4511
|
202: components["responses"]["202"];
|
3505
4512
|
400: components["responses"]["400"];
|
@@ -3512,27 +4519,40 @@ export interface operations {
|
|
3512
4519
|
503: components["responses"]["503"];
|
3513
4520
|
};
|
3514
4521
|
};
|
3515
|
-
/**
|
3516
|
-
* Return bulk quote information
|
3517
|
-
* @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.
|
3518
|
-
*/
|
3519
4522
|
BulkQuotesByID1: {
|
3520
4523
|
parameters: {
|
4524
|
+
query?: never;
|
3521
4525
|
header: {
|
4526
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3522
4527
|
"Content-Type": components["parameters"]["Content-Type"];
|
4528
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3523
4529
|
Date: components["parameters"]["Date"];
|
4530
|
+
/** @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.
|
4531
|
+
*
|
4532
|
+
* **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`. */
|
3524
4533
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4534
|
+
/** @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`). */
|
3525
4535
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4536
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3526
4537
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4538
|
+
/** @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. */
|
3527
4539
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4540
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3528
4541
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4542
|
+
/** @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). */
|
3529
4543
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4544
|
+
/** @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). */
|
3530
4545
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4546
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4547
|
+
*
|
4548
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3531
4549
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3532
4550
|
};
|
3533
4551
|
path: {
|
4552
|
+
/** @description The identifier value. */
|
3534
4553
|
ID: components["parameters"]["ID"];
|
3535
4554
|
};
|
4555
|
+
cookie?: never;
|
3536
4556
|
};
|
3537
4557
|
/** @description Bulk quote information returned. */
|
3538
4558
|
requestBody: {
|
@@ -3552,27 +4572,40 @@ export interface operations {
|
|
3552
4572
|
503: components["responses"]["503"];
|
3553
4573
|
};
|
3554
4574
|
};
|
3555
|
-
/**
|
3556
|
-
* Return bulk quote information error
|
3557
|
-
* @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.
|
3558
|
-
*/
|
3559
4575
|
BulkQuotesErrorByID: {
|
3560
4576
|
parameters: {
|
4577
|
+
query?: never;
|
3561
4578
|
header: {
|
4579
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4580
|
+
*
|
4581
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3562
4582
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4583
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3563
4584
|
"Content-Type": components["parameters"]["Content-Type"];
|
4585
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3564
4586
|
Date: components["parameters"]["Date"];
|
4587
|
+
/** @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.
|
4588
|
+
*
|
4589
|
+
* **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`. */
|
3565
4590
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4591
|
+
/** @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`). */
|
3566
4592
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4593
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3567
4594
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4595
|
+
/** @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. */
|
3568
4596
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4597
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3569
4598
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4599
|
+
/** @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). */
|
3570
4600
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4601
|
+
/** @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). */
|
3571
4602
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3572
4603
|
};
|
3573
4604
|
path: {
|
4605
|
+
/** @description The identifier value. */
|
3574
4606
|
ID: components["parameters"]["ID"];
|
3575
4607
|
};
|
4608
|
+
cookie?: never;
|
3576
4609
|
};
|
3577
4610
|
/** @description Details of the error returned. */
|
3578
4611
|
requestBody: {
|
@@ -3592,25 +4625,39 @@ export interface operations {
|
|
3592
4625
|
503: components["responses"]["503"];
|
3593
4626
|
};
|
3594
4627
|
};
|
3595
|
-
/**
|
3596
|
-
* Perform bulk transfer
|
3597
|
-
* @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
|
3598
|
-
*/
|
3599
4628
|
BulkTransfers: {
|
3600
4629
|
parameters: {
|
4630
|
+
query?: never;
|
3601
4631
|
header: {
|
4632
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3602
4633
|
Accept: components["parameters"]["Accept"];
|
4634
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4635
|
+
*
|
4636
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3603
4637
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4638
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3604
4639
|
"Content-Type": components["parameters"]["Content-Type"];
|
4640
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3605
4641
|
Date: components["parameters"]["Date"];
|
4642
|
+
/** @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.
|
4643
|
+
*
|
4644
|
+
* **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`. */
|
3606
4645
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4646
|
+
/** @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`). */
|
3607
4647
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4648
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3608
4649
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4650
|
+
/** @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. */
|
3609
4651
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4652
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3610
4653
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4654
|
+
/** @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). */
|
3611
4655
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4656
|
+
/** @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). */
|
3612
4657
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3613
4658
|
};
|
4659
|
+
path?: never;
|
4660
|
+
cookie?: never;
|
3614
4661
|
};
|
3615
4662
|
/** @description Details of the bulk transfer to be created. */
|
3616
4663
|
requestBody: {
|
@@ -3630,28 +4677,40 @@ export interface operations {
|
|
3630
4677
|
503: components["responses"]["503"];
|
3631
4678
|
};
|
3632
4679
|
};
|
3633
|
-
/**
|
3634
|
-
* Retrieve bulk transfer information
|
3635
|
-
* @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.
|
3636
|
-
*/
|
3637
4680
|
BulkTransferByID: {
|
3638
4681
|
parameters: {
|
4682
|
+
query?: never;
|
3639
4683
|
header: {
|
4684
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3640
4685
|
"Content-Type": components["parameters"]["Content-Type"];
|
4686
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3641
4687
|
Date: components["parameters"]["Date"];
|
4688
|
+
/** @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.
|
4689
|
+
*
|
4690
|
+
* **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`. */
|
3642
4691
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4692
|
+
/** @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`). */
|
3643
4693
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4694
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3644
4695
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4696
|
+
/** @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. */
|
3645
4697
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4698
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3646
4699
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4700
|
+
/** @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). */
|
3647
4701
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4702
|
+
/** @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). */
|
3648
4703
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4704
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
3649
4705
|
Accept: components["parameters"]["Accept"];
|
3650
4706
|
};
|
3651
4707
|
path: {
|
4708
|
+
/** @description The identifier value. */
|
3652
4709
|
ID: components["parameters"]["ID"];
|
3653
4710
|
};
|
4711
|
+
cookie?: never;
|
3654
4712
|
};
|
4713
|
+
requestBody?: never;
|
3655
4714
|
responses: {
|
3656
4715
|
202: components["responses"]["202"];
|
3657
4716
|
400: components["responses"]["400"];
|
@@ -3664,27 +4723,40 @@ export interface operations {
|
|
3664
4723
|
503: components["responses"]["503"];
|
3665
4724
|
};
|
3666
4725
|
};
|
3667
|
-
/**
|
3668
|
-
* Return bulk transfer information
|
3669
|
-
* @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.
|
3670
|
-
*/
|
3671
4726
|
BulkTransfersByIDPut: {
|
3672
4727
|
parameters: {
|
4728
|
+
query?: never;
|
3673
4729
|
header: {
|
4730
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3674
4731
|
"Content-Type": components["parameters"]["Content-Type"];
|
4732
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3675
4733
|
Date: components["parameters"]["Date"];
|
4734
|
+
/** @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.
|
4735
|
+
*
|
4736
|
+
* **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`. */
|
3676
4737
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4738
|
+
/** @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`). */
|
3677
4739
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4740
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3678
4741
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4742
|
+
/** @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. */
|
3679
4743
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4744
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3680
4745
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4746
|
+
/** @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). */
|
3681
4747
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4748
|
+
/** @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). */
|
3682
4749
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
4750
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4751
|
+
*
|
4752
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3683
4753
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
3684
4754
|
};
|
3685
4755
|
path: {
|
4756
|
+
/** @description The identifier value. */
|
3686
4757
|
ID: components["parameters"]["ID"];
|
3687
4758
|
};
|
4759
|
+
cookie?: never;
|
3688
4760
|
};
|
3689
4761
|
/** @description Bulk transfer information returned. */
|
3690
4762
|
requestBody: {
|
@@ -3704,27 +4776,40 @@ export interface operations {
|
|
3704
4776
|
503: components["responses"]["503"];
|
3705
4777
|
};
|
3706
4778
|
};
|
3707
|
-
/**
|
3708
|
-
* Return bulk transfer information error
|
3709
|
-
* @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.
|
3710
|
-
*/
|
3711
4779
|
BulkTransfersErrorByID: {
|
3712
4780
|
parameters: {
|
4781
|
+
query?: never;
|
3713
4782
|
header: {
|
4783
|
+
/** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4784
|
+
*
|
4785
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */
|
3714
4786
|
"Content-Length"?: components["parameters"]["Content-Length"];
|
4787
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
3715
4788
|
"Content-Type": components["parameters"]["Content-Type"];
|
4789
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
3716
4790
|
Date: components["parameters"]["Date"];
|
4791
|
+
/** @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.
|
4792
|
+
*
|
4793
|
+
* **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`. */
|
3717
4794
|
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
4795
|
+
/** @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`). */
|
3718
4796
|
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
4797
|
+
/** @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 should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */
|
3719
4798
|
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
4799
|
+
/** @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. */
|
3720
4800
|
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
4801
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
3721
4802
|
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
4803
|
+
/** @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). */
|
3722
4804
|
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
4805
|
+
/** @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). */
|
3723
4806
|
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3724
4807
|
};
|
3725
4808
|
path: {
|
4809
|
+
/** @description The identifier value. */
|
3726
4810
|
ID: components["parameters"]["ID"];
|
3727
4811
|
};
|
4812
|
+
cookie?: never;
|
3728
4813
|
};
|
3729
4814
|
/** @description Details of the error returned. */
|
3730
4815
|
requestBody: {
|