@mojaloop/api-snippets 17.6.0-snapshot.2 → 17.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/audit-ci.jsonc +4 -2
- package/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +6053 -0
- package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +1 -1
- package/docs/index.html +1 -0
- package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +1 -1
- package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +7 -7
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1 -1
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +1 -1
- package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml +20 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyCode.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml +20 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyCode.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AnyBICDec2014Identifier.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BICFIDec2014Identifier.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml +41 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml +38 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml +44 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml +45 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml +53 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml +39 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml +92 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml +84 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml +203 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml +117 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml +38 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorCode.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorDescription.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformation.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformationResponse.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact4AlphaNumericText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml +69 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Extension.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionKey.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionList.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionValue.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalAccountIdentification1Code.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCashAccountType1Code.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCategoryPurpose1Code.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +65 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +65 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml +85 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml +89 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml +65 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml +70 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml +77 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml +72 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml +54 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml +58 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODate.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISOYear.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml +34 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LEIIdentifier.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max105Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max10Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max128Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max140Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max15NumericText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max16Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max2048Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max256Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max34Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max350Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max35Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max4Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max70Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml +31 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml +31 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml +35 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml +30 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml +45 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml +70 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml +63 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml +62 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml +48 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PhoneNumber.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml +55 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml +61 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml +20 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml +37 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml +39 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml +56 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml +20 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml +105 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml +27 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml +36 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml +74 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml +43 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml +77 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/openapi.yaml +53 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}.yaml +81 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml +120 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}.yaml +82 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_error.yaml +50 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}.yaml +83 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}_error.yaml +51 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}.yaml +80 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml +119 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}_error.yaml +49 -0
- package/lib/fspiop/v1_0/openapi.d.ts +1494 -409
- package/lib/fspiop/v1_1/openapi.d.ts +1495 -417
- package/lib/fspiop/v2_0/json-schemas.json +39 -39
- package/lib/fspiop/v2_0/openapi.d.ts +1945 -560
- package/lib/fspiop/v2_0_ISO20022/index.d.ts +3 -0
- package/lib/fspiop/v2_0_ISO20022/index.js +9 -0
- package/lib/fspiop/v2_0_ISO20022/index.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/json-schemas.json +118444 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.d.ts +6077 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.js +7 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.d.ts +106043 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.js +171 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/types.d.ts +164 -0
- package/lib/fspiop/v2_0_ISO20022/types.js +4 -0
- package/lib/fspiop/v2_0_ISO20022/types.js.map +1 -0
- package/lib/index.d.ts +3 -0
- package/lib/index.js +4 -1
- package/lib/index.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +14 -14
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +384 -74
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +55 -55
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +543 -109
- package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +66 -66
- package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +503 -139
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +72 -72
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +694 -184
- package/lib/thirdparty/openapi.d.ts +1639 -612
- package/package.json +30 -27
- package/sdk-bulk.yaml +1 -1
- package/sdk-scheme-adapter/v2_0_0/components/schemas/CorrelationId.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +6 -6
- package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml +1 -1
@@ -4,27 +4,64 @@
|
|
4
4
|
*/
|
5
5
|
export interface paths {
|
6
6
|
"/": {
|
7
|
+
parameters: {
|
8
|
+
query?: never;
|
9
|
+
header?: never;
|
10
|
+
path?: never;
|
11
|
+
cookie?: never;
|
12
|
+
};
|
7
13
|
/**
|
8
14
|
* Health check endpoint
|
9
15
|
* @description This endpoint allows a user of the SDK scheme adapter to check the outbound transfers service is listening.
|
10
16
|
*/
|
11
17
|
get: {
|
18
|
+
parameters: {
|
19
|
+
query?: never;
|
20
|
+
header?: never;
|
21
|
+
path?: never;
|
22
|
+
cookie?: never;
|
23
|
+
};
|
24
|
+
requestBody?: never;
|
12
25
|
responses: {
|
13
26
|
/** @description Returns empty body if the scheme adapter outbound transfers service is running. */
|
14
27
|
200: {
|
15
|
-
|
28
|
+
headers: {
|
29
|
+
[name: string]: unknown;
|
30
|
+
};
|
31
|
+
content?: never;
|
16
32
|
};
|
17
33
|
};
|
18
34
|
};
|
35
|
+
put?: never;
|
36
|
+
post?: never;
|
37
|
+
delete?: never;
|
38
|
+
options?: never;
|
39
|
+
head?: never;
|
40
|
+
patch?: never;
|
41
|
+
trace?: never;
|
19
42
|
};
|
20
43
|
"/accounts": {
|
44
|
+
parameters: {
|
45
|
+
query?: never;
|
46
|
+
header?: never;
|
47
|
+
path?: never;
|
48
|
+
cookie?: never;
|
49
|
+
};
|
50
|
+
get?: never;
|
51
|
+
put?: never;
|
21
52
|
/**
|
22
53
|
* Create accounts on the Account Lookup Service
|
23
54
|
* @description The HTTP request `POST /accounts` is used to create account information on the Account Lookup Service (ALS) regarding the provided list of identities.
|
24
55
|
*
|
25
|
-
*
|
56
|
+
* Caller DFSP is used as the account source FSP information
|
26
57
|
*/
|
27
58
|
post: {
|
59
|
+
parameters: {
|
60
|
+
query?: never;
|
61
|
+
header?: never;
|
62
|
+
path?: never;
|
63
|
+
cookie?: never;
|
64
|
+
};
|
28
65
|
/** @description Identities list request body */
|
29
66
|
requestBody: {
|
30
67
|
content: {
|
@@ -38,13 +75,33 @@ export interface paths {
|
|
38
75
|
504: components["responses"]["accountsCreationTimeout"];
|
39
76
|
};
|
40
77
|
};
|
78
|
+
delete?: never;
|
79
|
+
options?: never;
|
80
|
+
head?: never;
|
81
|
+
patch?: never;
|
82
|
+
trace?: never;
|
41
83
|
};
|
42
84
|
"/bulkQuotes": {
|
85
|
+
parameters: {
|
86
|
+
query?: never;
|
87
|
+
header?: never;
|
88
|
+
path?: never;
|
89
|
+
cookie?: never;
|
90
|
+
};
|
91
|
+
get?: never;
|
92
|
+
put?: never;
|
43
93
|
/**
|
44
94
|
* Request bulk quotes for the provided financial transactions
|
45
95
|
* @description The HTTP request `POST /bulkQuotes` is used to request a bulk quote to fascilitate funds transfer from payer DFSP to payees' DFSP.
|
96
|
+
*
|
46
97
|
*/
|
47
98
|
post: {
|
99
|
+
parameters: {
|
100
|
+
query?: never;
|
101
|
+
header?: never;
|
102
|
+
path?: never;
|
103
|
+
cookie?: never;
|
104
|
+
};
|
48
105
|
/** @description Bulk quote request body */
|
49
106
|
requestBody: {
|
50
107
|
content: {
|
@@ -58,40 +115,84 @@ export interface paths {
|
|
58
115
|
504: components["responses"]["bulkQuoteTimeout"];
|
59
116
|
};
|
60
117
|
};
|
118
|
+
delete?: never;
|
119
|
+
options?: never;
|
120
|
+
head?: never;
|
121
|
+
patch?: never;
|
122
|
+
trace?: never;
|
61
123
|
};
|
62
124
|
"/bulkQuotes/{bulkQuoteId}": {
|
125
|
+
parameters: {
|
126
|
+
query?: never;
|
127
|
+
header?: never;
|
128
|
+
path?: never;
|
129
|
+
cookie?: never;
|
130
|
+
};
|
63
131
|
/**
|
64
132
|
* Retrieves information for a specific bulk quote
|
65
133
|
* @description The HTTP request `GET /bulkQuotes/{bulktQuoteId}` is used to get information regarding a bulk quote created or requested earlier. The `{bulkQuoteId}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
|
66
134
|
*/
|
67
135
|
get: {
|
68
136
|
parameters: {
|
137
|
+
query?: never;
|
138
|
+
header?: never;
|
69
139
|
path: {
|
140
|
+
/** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
|
70
141
|
bulkQuoteId: components["parameters"]["bulkQuoteId"];
|
71
142
|
};
|
143
|
+
cookie?: never;
|
72
144
|
};
|
145
|
+
requestBody?: never;
|
73
146
|
responses: {
|
74
147
|
/** @description Bulk quote information successfully retrieved */
|
75
148
|
200: {
|
149
|
+
headers: {
|
150
|
+
[name: string]: unknown;
|
151
|
+
};
|
76
152
|
content: {
|
77
153
|
"application/json": components["schemas"]["bulkQuoteStatusResponse"];
|
78
154
|
};
|
79
155
|
};
|
80
156
|
/** @description An error occurred processing the bulk quote */
|
81
157
|
500: {
|
158
|
+
headers: {
|
159
|
+
[name: string]: unknown;
|
160
|
+
};
|
82
161
|
content: {
|
83
162
|
"application/json": components["schemas"]["errorResponse"];
|
84
163
|
};
|
85
164
|
};
|
86
165
|
};
|
87
166
|
};
|
167
|
+
put?: never;
|
168
|
+
post?: never;
|
169
|
+
delete?: never;
|
170
|
+
options?: never;
|
171
|
+
head?: never;
|
172
|
+
patch?: never;
|
173
|
+
trace?: never;
|
88
174
|
};
|
89
175
|
"/bulkTransactions": {
|
176
|
+
parameters: {
|
177
|
+
query?: never;
|
178
|
+
header?: never;
|
179
|
+
path?: never;
|
180
|
+
cookie?: never;
|
181
|
+
};
|
182
|
+
get?: never;
|
183
|
+
put?: never;
|
90
184
|
/**
|
91
185
|
* Sends money from one account to multiple accounts
|
92
186
|
* @description The HTTP request `POST /bulkTransactions` is used to request the movement of funds from payer DFSP to payees' DFSP.
|
187
|
+
*
|
93
188
|
*/
|
94
189
|
post: {
|
190
|
+
parameters: {
|
191
|
+
query?: never;
|
192
|
+
header?: never;
|
193
|
+
path?: never;
|
194
|
+
cookie?: never;
|
195
|
+
};
|
95
196
|
/** @description Bulk transfer request body */
|
96
197
|
requestBody: {
|
97
198
|
content: {
|
@@ -104,17 +205,33 @@ export interface paths {
|
|
104
205
|
500: components["responses"]["errorResponse"];
|
105
206
|
};
|
106
207
|
};
|
208
|
+
delete?: never;
|
209
|
+
options?: never;
|
210
|
+
head?: never;
|
211
|
+
patch?: never;
|
212
|
+
trace?: never;
|
107
213
|
};
|
108
214
|
"/bulkTransactions/{bulkTransactionId}": {
|
215
|
+
parameters: {
|
216
|
+
query?: never;
|
217
|
+
header?: never;
|
218
|
+
path?: never;
|
219
|
+
cookie?: never;
|
220
|
+
};
|
221
|
+
get?: never;
|
109
222
|
/**
|
110
223
|
* Amends the bulk transaction request
|
111
224
|
* @description The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
|
112
225
|
*/
|
113
226
|
put: {
|
114
227
|
parameters: {
|
228
|
+
query?: never;
|
229
|
+
header?: never;
|
115
230
|
path: {
|
231
|
+
/** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
|
116
232
|
bulkTransactionId: components["parameters"]["bulkTransactionId"];
|
117
233
|
};
|
234
|
+
cookie?: never;
|
118
235
|
};
|
119
236
|
/** @description Bulk transaction request body */
|
120
237
|
requestBody: {
|
@@ -125,24 +242,51 @@ export interface paths {
|
|
125
242
|
responses: {
|
126
243
|
/** @description Bulk transaction information successfully amended */
|
127
244
|
202: {
|
128
|
-
|
245
|
+
headers: {
|
246
|
+
[name: string]: unknown;
|
247
|
+
};
|
248
|
+
content?: never;
|
129
249
|
};
|
130
250
|
400: components["responses"]["bulkTransactionPutBadRequest"];
|
131
251
|
/** @description An error occurred processing the bulk transaction */
|
132
252
|
500: {
|
253
|
+
headers: {
|
254
|
+
[name: string]: unknown;
|
255
|
+
};
|
133
256
|
content: {
|
134
257
|
"application/json": components["schemas"]["errorResponse"];
|
135
258
|
};
|
136
259
|
};
|
137
260
|
};
|
138
261
|
};
|
262
|
+
post?: never;
|
263
|
+
delete?: never;
|
264
|
+
options?: never;
|
265
|
+
head?: never;
|
266
|
+
patch?: never;
|
267
|
+
trace?: never;
|
139
268
|
};
|
140
269
|
"/bulkTransfers": {
|
270
|
+
parameters: {
|
271
|
+
query?: never;
|
272
|
+
header?: never;
|
273
|
+
path?: never;
|
274
|
+
cookie?: never;
|
275
|
+
};
|
276
|
+
get?: never;
|
277
|
+
put?: never;
|
141
278
|
/**
|
142
279
|
* Sends money from one account to multiple accounts
|
143
280
|
* @description The HTTP request `POST /bulkTransfers` is used to request the movement of funds from payer DFSP to payees' DFSP.
|
281
|
+
*
|
144
282
|
*/
|
145
283
|
post: {
|
284
|
+
parameters: {
|
285
|
+
query?: never;
|
286
|
+
header?: never;
|
287
|
+
path?: never;
|
288
|
+
cookie?: never;
|
289
|
+
};
|
146
290
|
/** @description Bulk transfer request body */
|
147
291
|
requestBody: {
|
148
292
|
content: {
|
@@ -155,78 +299,160 @@ export interface paths {
|
|
155
299
|
500: components["responses"]["errorResponse"];
|
156
300
|
};
|
157
301
|
};
|
302
|
+
delete?: never;
|
303
|
+
options?: never;
|
304
|
+
head?: never;
|
305
|
+
patch?: never;
|
306
|
+
trace?: never;
|
158
307
|
};
|
159
308
|
"/bulkTransfers/{bulkTransferId}": {
|
309
|
+
parameters: {
|
310
|
+
query?: never;
|
311
|
+
header?: never;
|
312
|
+
path?: never;
|
313
|
+
cookie?: never;
|
314
|
+
};
|
160
315
|
/**
|
161
316
|
* Retrieves information for a specific bulk transfer
|
162
317
|
* @description The HTTP request `GET /bulkTransfers/{bulkTransferId}` is used to get information regarding a bulk transfer created or requested earlier. The `{bulkTransferId}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
|
163
318
|
*/
|
164
319
|
get: {
|
165
320
|
parameters: {
|
321
|
+
query?: never;
|
322
|
+
header?: never;
|
166
323
|
path: {
|
324
|
+
/** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */
|
167
325
|
bulkTransferId: components["parameters"]["bulkTransferId"];
|
168
326
|
};
|
327
|
+
cookie?: never;
|
169
328
|
};
|
329
|
+
requestBody?: never;
|
170
330
|
responses: {
|
171
331
|
/** @description Bulk transfer information successfully retrieved */
|
172
332
|
200: {
|
333
|
+
headers: {
|
334
|
+
[name: string]: unknown;
|
335
|
+
};
|
173
336
|
content: {
|
174
337
|
"application/json": components["schemas"]["bulkTransferStatusResponse"];
|
175
338
|
};
|
176
339
|
};
|
177
340
|
/** @description An error occurred processing the bulk transfer */
|
178
341
|
500: {
|
342
|
+
headers: {
|
343
|
+
[name: string]: unknown;
|
344
|
+
};
|
179
345
|
content: {
|
180
346
|
"application/json": components["schemas"]["errorResponse"];
|
181
347
|
};
|
182
348
|
};
|
183
349
|
};
|
184
350
|
};
|
351
|
+
put?: never;
|
352
|
+
post?: never;
|
353
|
+
delete?: never;
|
354
|
+
options?: never;
|
355
|
+
head?: never;
|
356
|
+
patch?: never;
|
357
|
+
trace?: never;
|
185
358
|
};
|
186
359
|
"/parties/{Type}/{ID}": {
|
187
|
-
/**
|
188
|
-
* PartiesByTypeAndID
|
189
|
-
* @description The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
|
190
|
-
*/
|
191
|
-
get: operations["PartiesByTypeAndID"];
|
192
360
|
parameters: {
|
361
|
+
query?: never;
|
362
|
+
header?: never;
|
193
363
|
path: {
|
364
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
194
365
|
Type: components["parameters"]["Type"];
|
366
|
+
/** @description The identifier value. */
|
195
367
|
ID: components["parameters"]["ID"];
|
196
368
|
};
|
369
|
+
cookie?: never;
|
197
370
|
};
|
198
|
-
};
|
199
|
-
"/parties/{Type}/{ID}/{SubId}": {
|
200
371
|
/**
|
201
|
-
*
|
372
|
+
* PartiesByTypeAndID
|
202
373
|
* @description The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
|
203
374
|
*/
|
204
|
-
get: operations["
|
375
|
+
get: operations["PartiesByTypeAndID"];
|
376
|
+
put?: never;
|
377
|
+
post?: never;
|
378
|
+
delete?: never;
|
379
|
+
options?: never;
|
380
|
+
head?: never;
|
381
|
+
patch?: never;
|
382
|
+
trace?: never;
|
383
|
+
};
|
384
|
+
"/parties/{Type}/{ID}/{SubId}": {
|
205
385
|
parameters: {
|
386
|
+
query?: never;
|
387
|
+
header?: never;
|
206
388
|
path: {
|
389
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
207
390
|
Type: components["parameters"]["Type"];
|
391
|
+
/** @description The identifier value. */
|
208
392
|
ID: components["parameters"]["ID"];
|
393
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
209
394
|
SubId: components["parameters"]["SubId"];
|
210
395
|
};
|
396
|
+
cookie?: never;
|
211
397
|
};
|
398
|
+
/**
|
399
|
+
* PartiesSubIdByTypeAndID
|
400
|
+
* @description The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
|
401
|
+
*/
|
402
|
+
get: operations["PartiesSubIdByTypeAndID"];
|
403
|
+
put?: never;
|
404
|
+
post?: never;
|
405
|
+
delete?: never;
|
406
|
+
options?: never;
|
407
|
+
head?: never;
|
408
|
+
patch?: never;
|
409
|
+
trace?: never;
|
212
410
|
};
|
213
411
|
"/quotes": {
|
412
|
+
parameters: {
|
413
|
+
query?: never;
|
414
|
+
header?: never;
|
415
|
+
path?: never;
|
416
|
+
cookie?: never;
|
417
|
+
};
|
418
|
+
get?: never;
|
419
|
+
put?: never;
|
214
420
|
/**
|
215
421
|
* Quotes endpoint
|
216
422
|
* @description is used to request quotes from other DFSP
|
217
423
|
*/
|
218
424
|
post: operations["QuotesPost"];
|
425
|
+
delete?: never;
|
426
|
+
options?: never;
|
427
|
+
head?: never;
|
428
|
+
patch?: never;
|
429
|
+
trace?: never;
|
219
430
|
};
|
220
431
|
"/requestToPay": {
|
432
|
+
parameters: {
|
433
|
+
query?: never;
|
434
|
+
header?: never;
|
435
|
+
path?: never;
|
436
|
+
cookie?: never;
|
437
|
+
};
|
438
|
+
get?: never;
|
439
|
+
put?: never;
|
221
440
|
/**
|
222
441
|
* Receiver requesting funds from Sender
|
223
442
|
* @description The HTTP request `POST /requestToPay` is used to support Pull Funds pattern where in a receiver can request for funds from the Sender.
|
224
|
-
*
|
443
|
+
* The underlying API has two stages:
|
444
|
+
*
|
445
|
+
* 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
|
446
|
+
* 2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee.
|
225
447
|
*
|
226
|
-
* 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
|
227
|
-
* 2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee.
|
228
448
|
*/
|
229
449
|
post: {
|
450
|
+
parameters: {
|
451
|
+
query?: never;
|
452
|
+
header?: never;
|
453
|
+
path?: never;
|
454
|
+
cookie?: never;
|
455
|
+
};
|
230
456
|
/** @description RequestToPay request body */
|
231
457
|
requestBody: {
|
232
458
|
content: {
|
@@ -237,19 +463,36 @@ export interface paths {
|
|
237
463
|
200: components["responses"]["requestToPaySuccess"];
|
238
464
|
};
|
239
465
|
};
|
466
|
+
delete?: never;
|
467
|
+
options?: never;
|
468
|
+
head?: never;
|
469
|
+
patch?: never;
|
470
|
+
trace?: never;
|
240
471
|
};
|
241
472
|
"/requestToPay/{transactionRequestId}": {
|
473
|
+
parameters: {
|
474
|
+
query?: never;
|
475
|
+
header?: never;
|
476
|
+
path?: never;
|
477
|
+
cookie?: never;
|
478
|
+
};
|
479
|
+
get?: never;
|
242
480
|
/**
|
243
481
|
* Continues a request funds from sender that has paused at the party resolution stage in order to accept or reject party information
|
244
482
|
* @description The HTTP request `PUT /requestToPay/{transactionRequestId}` is used to continue a transfer initiated via the `POST /requestToPay` method that has halted after party lookup stage.
|
245
|
-
*
|
246
|
-
*
|
483
|
+
* The request body should contain the "acceptParty" property set to `true` as required to continue the transfer.
|
484
|
+
* See the description of the `POST /requestToPay` HTTP method for more information on modes of transfer.
|
485
|
+
*
|
247
486
|
*/
|
248
487
|
put: {
|
249
488
|
parameters: {
|
489
|
+
query?: never;
|
490
|
+
header?: never;
|
250
491
|
path: {
|
492
|
+
/** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
|
251
493
|
transactionRequestId: components["parameters"]["transactionRequestId"];
|
252
494
|
};
|
495
|
+
cookie?: never;
|
253
496
|
};
|
254
497
|
requestBody?: {
|
255
498
|
content: {
|
@@ -262,31 +505,52 @@ export interface paths {
|
|
262
505
|
504: components["responses"]["transferTimeout"];
|
263
506
|
};
|
264
507
|
};
|
508
|
+
post?: never;
|
509
|
+
delete?: never;
|
510
|
+
options?: never;
|
511
|
+
head?: never;
|
512
|
+
patch?: never;
|
513
|
+
trace?: never;
|
265
514
|
};
|
266
515
|
"/requestToPayTransfer": {
|
516
|
+
parameters: {
|
517
|
+
query?: never;
|
518
|
+
header?: never;
|
519
|
+
path?: never;
|
520
|
+
cookie?: never;
|
521
|
+
};
|
522
|
+
get?: never;
|
523
|
+
put?: never;
|
267
524
|
/**
|
268
525
|
* Used to trigger funds from customer fsp account to merchant fsp account. This is a follow-up request to requestToPay.
|
269
526
|
* @description The HTTP request `POST /requestToPayTransfer` is used to request the movement of funds from payer DFSP to payee DFSP.
|
270
|
-
*
|
527
|
+
* The underlying Mojaloop API has three stages for money transfer:
|
271
528
|
*
|
272
|
-
*
|
273
|
-
*
|
274
|
-
*
|
529
|
+
* 1. Quotation. This facilitates the exchange of fee information and the construction of a cryptographic "contract" between payee and payer DFSPs before funds are transferred.
|
530
|
+
* 2. Authorization. This facilitates getting OTP from payee DFSP.
|
531
|
+
* 3. Transfer. The enactment of the previously agreed "contract"
|
275
532
|
*
|
276
|
-
*
|
277
|
-
*
|
278
|
-
*
|
279
|
-
*
|
533
|
+
* This method has several modes of operation.
|
534
|
+
* - If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"` this method will terminate and return the quotation when it has been received from the payee DFSP.
|
535
|
+
* If the payee wished to proceed with the otp, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
|
536
|
+
* The scheme adapter will then proceed with the transfer state.
|
280
537
|
*
|
281
|
-
*
|
282
|
-
*
|
283
|
-
*
|
538
|
+
* - If the configuration variable `AUTO_ACCEPT_OTP` is set to `"false"` this method will terminate and return the otp when it has been received from the payee DFSP.
|
539
|
+
* If the payer wished to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
|
540
|
+
* The scheme adapter will then proceed with the transfer state.
|
284
541
|
*
|
285
|
-
*
|
542
|
+
* If the configuration variables `AUTO_ACCEPT_PARTIES` and `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block until all three transfer stages are complete. Upon completion it will return the entire set of transfer details received during the operation.
|
543
|
+
*
|
544
|
+
* Combinations of settings for `AUTO_ACCEPT...` configuration variables allow the scheme adapter user to decide which mode of operation best suits their use cases. i.e. the scheme adapter can be configured to "break" the three stage transfer at these points in order to execute backend logic such as party verification, quoted fees assessments etc...
|
286
545
|
*
|
287
|
-
* Combinations of settings for `AUTO_ACCEPT...` configuration variables allow the scheme adapter user to decide which mode of operation best suits their use cases. i.e. the scheme adapter can be configured to "break" the three stage transfer at these points in order to execute backend logic such as party verification, quoted fees assessments etc...
|
288
546
|
*/
|
289
547
|
post: {
|
548
|
+
parameters: {
|
549
|
+
query?: never;
|
550
|
+
header?: never;
|
551
|
+
path?: never;
|
552
|
+
cookie?: never;
|
553
|
+
};
|
290
554
|
/** @description Request To Pay Transfer request body */
|
291
555
|
requestBody: {
|
292
556
|
content: {
|
@@ -300,21 +564,38 @@ export interface paths {
|
|
300
564
|
504: components["responses"]["transferTimeout"];
|
301
565
|
};
|
302
566
|
};
|
567
|
+
delete?: never;
|
568
|
+
options?: never;
|
569
|
+
head?: never;
|
570
|
+
patch?: never;
|
571
|
+
trace?: never;
|
303
572
|
};
|
304
573
|
"/requestToPayTransfer/{transactionRequestId}": {
|
574
|
+
parameters: {
|
575
|
+
query?: never;
|
576
|
+
header?: never;
|
577
|
+
path?: never;
|
578
|
+
cookie?: never;
|
579
|
+
};
|
580
|
+
get?: never;
|
305
581
|
/**
|
306
582
|
* Continues a transfer that has paused at the otp stage in order to accept or reject quote
|
307
583
|
* @description This request is used to continue a requestToPayTransfer initiated via the `POST /requestToPayTransfer` method that has halted after quotation stage and/or otp stage.
|
308
584
|
*
|
309
|
-
*
|
585
|
+
* The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer.
|
586
|
+
*
|
587
|
+
* See the description of the `POST /requestToPayTransfer` HTTP method for more information on modes of transfer.
|
310
588
|
*
|
311
|
-
* See the description of the `POST /requestToPayTransfer` HTTP method for more information on modes of transfer.
|
312
589
|
*/
|
313
590
|
put: {
|
314
591
|
parameters: {
|
592
|
+
query?: never;
|
593
|
+
header?: never;
|
315
594
|
path: {
|
595
|
+
/** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */
|
316
596
|
transactionRequestId: components["parameters"]["transactionRequestId"];
|
317
597
|
};
|
598
|
+
cookie?: never;
|
318
599
|
};
|
319
600
|
requestBody?: {
|
320
601
|
content: {
|
@@ -327,38 +608,72 @@ export interface paths {
|
|
327
608
|
504: components["responses"]["transferTimeout"];
|
328
609
|
};
|
329
610
|
};
|
611
|
+
post?: never;
|
612
|
+
delete?: never;
|
613
|
+
options?: never;
|
614
|
+
head?: never;
|
615
|
+
patch?: never;
|
616
|
+
trace?: never;
|
330
617
|
};
|
331
618
|
"/simpleTransfers": {
|
619
|
+
parameters: {
|
620
|
+
query?: never;
|
621
|
+
header?: never;
|
622
|
+
path?: never;
|
623
|
+
cookie?: never;
|
624
|
+
};
|
625
|
+
get?: never;
|
626
|
+
put?: never;
|
332
627
|
/**
|
333
628
|
* Simple Transfers endpoint
|
334
629
|
* @description is used to request a transfer
|
335
630
|
*/
|
336
631
|
post: operations["SimpleTransfersPost"];
|
632
|
+
delete?: never;
|
633
|
+
options?: never;
|
634
|
+
head?: never;
|
635
|
+
patch?: never;
|
636
|
+
trace?: never;
|
337
637
|
};
|
338
638
|
"/transfers": {
|
639
|
+
parameters: {
|
640
|
+
query?: never;
|
641
|
+
header?: never;
|
642
|
+
path?: never;
|
643
|
+
cookie?: never;
|
644
|
+
};
|
645
|
+
get?: never;
|
646
|
+
put?: never;
|
339
647
|
/**
|
340
648
|
* Sends money from one account to another
|
341
649
|
* @description The HTTP request `POST /transfers` is used to request the movement of funds from payer DFSP to payee DFSP.
|
342
|
-
*
|
650
|
+
* The underlying Mojaloop API has three stages for money transfer:
|
651
|
+
*
|
652
|
+
* 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
|
653
|
+
* 2. Quotation. This facilitates the exchange of fee information and the construction of a cryptographic "contract" between payee and payer DFSPs before funds are transferred.
|
654
|
+
* 3. Transfer. The enactment of the previously agreed "contract"
|
343
655
|
*
|
344
|
-
*
|
345
|
-
*
|
346
|
-
*
|
656
|
+
* This method has several modes of operation.
|
657
|
+
* - If the configuration variables `AUTO_ACCEPT_PARTIES` is set to `"false"` this method will terminate when the payee party has been resolved and return the payee party details.
|
658
|
+
* If the payee wishes to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the payee party) is required to continue the operation.
|
659
|
+
* The scheme adapter will then proceed with quotation stage...
|
347
660
|
*
|
348
|
-
*
|
349
|
-
*
|
350
|
-
*
|
351
|
-
* The scheme adapter will then proceed with quotation stage...
|
661
|
+
* - If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"` this method will terminate and return the quotation when it has been received from the payee DFSP.
|
662
|
+
* If the payee wished to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
|
663
|
+
* The scheme adapter will then proceed with the transfer state.
|
352
664
|
*
|
353
|
-
*
|
354
|
-
* If the payee wished to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
|
355
|
-
* The scheme adapter will then proceed with the transfer state.
|
665
|
+
* If the configuration variables `AUTO_ACCEPT_PARTIES` and `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block until all three transfer stages are complete. Upon completion it will return the entire set of transfer details received during the operation.
|
356
666
|
*
|
357
|
-
*
|
667
|
+
* Combinations of settings for `AUTO_ACCEPT...` configuration variables allow the scheme adapter user to decide which mode of operation best suits their use cases. i.e. the scheme adapter can be configured to "break" the three stage transfer at these points in order to execute backend logic such as party verification, quoted fees assessments etc...
|
358
668
|
*
|
359
|
-
* Combinations of settings for `AUTO_ACCEPT...` configuration variables allow the scheme adapter user to decide which mode of operation best suits their use cases. i.e. the scheme adapter can be configured to "break" the three stage transfer at these points in order to execute backend logic such as party verification, quoted fees assessments etc...
|
360
669
|
*/
|
361
670
|
post: {
|
671
|
+
parameters: {
|
672
|
+
query?: never;
|
673
|
+
header?: never;
|
674
|
+
path?: never;
|
675
|
+
cookie?: never;
|
676
|
+
};
|
362
677
|
/** @description Transfer request body */
|
363
678
|
requestBody: {
|
364
679
|
content: {
|
@@ -372,27 +687,49 @@ export interface paths {
|
|
372
687
|
504: components["responses"]["transferTimeout"];
|
373
688
|
};
|
374
689
|
};
|
690
|
+
delete?: never;
|
691
|
+
options?: never;
|
692
|
+
head?: never;
|
693
|
+
patch?: never;
|
694
|
+
trace?: never;
|
375
695
|
};
|
376
696
|
"/transfers/{transferId}": {
|
697
|
+
parameters: {
|
698
|
+
query?: never;
|
699
|
+
header?: never;
|
700
|
+
path?: never;
|
701
|
+
cookie?: never;
|
702
|
+
};
|
377
703
|
/**
|
378
704
|
* Retrieves information for a specific transfer
|
379
705
|
* @description The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
380
706
|
*/
|
381
707
|
get: {
|
382
708
|
parameters: {
|
709
|
+
query?: never;
|
710
|
+
header?: never;
|
383
711
|
path: {
|
712
|
+
/** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */
|
384
713
|
transferId: components["parameters"]["transferId"];
|
385
714
|
};
|
715
|
+
cookie?: never;
|
386
716
|
};
|
717
|
+
requestBody?: never;
|
387
718
|
responses: {
|
388
719
|
/** @description Transfer information successfully retrieved */
|
389
720
|
200: {
|
721
|
+
headers: {
|
722
|
+
[name: string]: unknown;
|
723
|
+
};
|
390
724
|
content: {
|
391
725
|
"application/json": components["schemas"]["transferStatusResponse"];
|
392
726
|
};
|
393
727
|
};
|
394
728
|
/** @description An error occurred processing the transfer */
|
395
729
|
500: {
|
730
|
+
headers: {
|
731
|
+
[name: string]: unknown;
|
732
|
+
};
|
396
733
|
content: {
|
397
734
|
"application/json": components["schemas"]["errorResponse"];
|
398
735
|
};
|
@@ -403,15 +740,20 @@ export interface paths {
|
|
403
740
|
* Continues a transfer that has paused at the quote stage in order to accept or reject payee party and/or quote
|
404
741
|
* @description The HTTP request `PUT /transfers/{transferId}` is used to continue a transfer initiated via the `POST /transfers` method that has halted after party lookup and/or quotation stage.
|
405
742
|
*
|
406
|
-
*
|
743
|
+
* The request body should contain either the "acceptParty" or "acceptQuote" property set to `true` as required to continue the transfer.
|
744
|
+
*
|
745
|
+
* See the description of the `POST /transfers` HTTP method for more information on modes of transfer.
|
407
746
|
*
|
408
|
-
* See the description of the `POST /transfers` HTTP method for more information on modes of transfer.
|
409
747
|
*/
|
410
748
|
put: {
|
411
749
|
parameters: {
|
750
|
+
query?: never;
|
751
|
+
header?: never;
|
412
752
|
path: {
|
753
|
+
/** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */
|
413
754
|
transferId: components["parameters"]["transferId"];
|
414
755
|
};
|
756
|
+
cookie?: never;
|
415
757
|
};
|
416
758
|
requestBody?: {
|
417
759
|
content: {
|
@@ -424,6 +766,12 @@ export interface paths {
|
|
424
766
|
504: components["responses"]["transferTimeout"];
|
425
767
|
};
|
426
768
|
};
|
769
|
+
post?: never;
|
770
|
+
delete?: never;
|
771
|
+
options?: never;
|
772
|
+
head?: never;
|
773
|
+
patch?: never;
|
774
|
+
trace?: never;
|
427
775
|
};
|
428
776
|
}
|
429
777
|
export type webhooks = Record<string, never>;
|
@@ -432,14 +780,14 @@ export interface components {
|
|
432
780
|
/**
|
433
781
|
* PartyIdType
|
434
782
|
* @description Below are the allowed values for the enumeration.
|
435
|
-
*
|
436
|
-
*
|
437
|
-
*
|
438
|
-
*
|
439
|
-
*
|
440
|
-
*
|
441
|
-
*
|
442
|
-
*
|
783
|
+
* - 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.
|
784
|
+
* - 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).
|
785
|
+
* - 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.
|
786
|
+
* - 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.
|
787
|
+
* - 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.
|
788
|
+
* - 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.
|
789
|
+
* - 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.
|
790
|
+
* - 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.
|
443
791
|
* @enum {string}
|
444
792
|
*/
|
445
793
|
PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
|
@@ -558,10 +906,10 @@ export interface components {
|
|
558
906
|
/**
|
559
907
|
* TransactionInitiatorType
|
560
908
|
* @description Below are the allowed values for the enumeration.
|
561
|
-
*
|
562
|
-
*
|
563
|
-
*
|
564
|
-
*
|
909
|
+
* - CONSUMER - Consumer is the initiator of the transaction.
|
910
|
+
* - AGENT - Agent is the initiator of the transaction.
|
911
|
+
* - BUSINESS - Business is the initiator of the transaction.
|
912
|
+
* - DEVICE - Device is the initiator of the transaction.
|
565
913
|
* @example CONSUMER
|
566
914
|
* @enum {string}
|
567
915
|
*/
|
@@ -570,9 +918,9 @@ export interface components {
|
|
570
918
|
* Name
|
571
919
|
* @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.
|
572
920
|
*
|
573
|
-
*
|
921
|
+
* 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 ( ).
|
574
922
|
*
|
575
|
-
*
|
923
|
+
* **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.
|
576
924
|
*/
|
577
925
|
Name: string;
|
578
926
|
/**
|
@@ -627,8 +975,8 @@ export interface components {
|
|
627
975
|
/**
|
628
976
|
* AmountType
|
629
977
|
* @description Below are the allowed values for the enumeration AmountType.
|
630
|
-
*
|
631
|
-
*
|
978
|
+
* - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
979
|
+
* - 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.
|
632
980
|
* @example RECEIVE
|
633
981
|
* @enum {string}
|
634
982
|
*/
|
@@ -865,10 +1213,10 @@ export interface components {
|
|
865
1213
|
/**
|
866
1214
|
* TransferState
|
867
1215
|
* @description Below are the allowed values for the enumeration.
|
868
|
-
*
|
869
|
-
*
|
870
|
-
*
|
871
|
-
*
|
1216
|
+
* - RECEIVED - Next ledger has received the transfer.
|
1217
|
+
* - RESERVED - Next ledger has reserved the transfer.
|
1218
|
+
* - COMMITTED - Next ledger has successfully performed the transfer.
|
1219
|
+
* - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
|
872
1220
|
* @example RESERVED
|
873
1221
|
* @enum {string}
|
874
1222
|
*/
|
@@ -929,12 +1277,12 @@ export interface components {
|
|
929
1277
|
httpStatusCode?: number;
|
930
1278
|
mojaloopError?: components["schemas"]["mojaloopError"];
|
931
1279
|
};
|
932
|
-
bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] &
|
1280
|
+
bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] & {
|
933
1281
|
bulkTransferState: components["schemas"]["bulkTransactionContinuationAcceptParty"] & components["schemas"]["partyError"];
|
934
|
-
}
|
935
|
-
bulkTransactionAcceptQuoteErrorResponse: components["schemas"]["errorResponse"] &
|
1282
|
+
};
|
1283
|
+
bulkTransactionAcceptQuoteErrorResponse: components["schemas"]["errorResponse"] & {
|
936
1284
|
bulkTransferState?: components["schemas"]["bulkTransactionContinuationAcceptQuote"] & components["schemas"]["quoteError"];
|
937
|
-
}
|
1285
|
+
};
|
938
1286
|
/**
|
939
1287
|
* IndividualTransfer
|
940
1288
|
* @description Data model for the complex type 'individualTransfer'.
|
@@ -988,11 +1336,11 @@ export interface components {
|
|
988
1336
|
/**
|
989
1337
|
* TransactionScenario
|
990
1338
|
* @description Below are the allowed values for the enumeration.
|
991
|
-
*
|
992
|
-
*
|
993
|
-
*
|
994
|
-
*
|
995
|
-
*
|
1339
|
+
* - 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.
|
1340
|
+
* - 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.
|
1341
|
+
* - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
1342
|
+
* - 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.
|
1343
|
+
* - REFUND - Used for performing a refund of transaction.
|
996
1344
|
* @example DEPOSIT
|
997
1345
|
* @enum {string}
|
998
1346
|
*/
|
@@ -1000,8 +1348,8 @@ export interface components {
|
|
1000
1348
|
/**
|
1001
1349
|
* TransactionInitiator
|
1002
1350
|
* @description Below are the allowed values for the enumeration.
|
1003
|
-
*
|
1004
|
-
*
|
1351
|
+
* - 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.
|
1352
|
+
* - 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.
|
1005
1353
|
* @example PAYEE
|
1006
1354
|
* @enum {string}
|
1007
1355
|
*/
|
@@ -1092,9 +1440,9 @@ export interface components {
|
|
1092
1440
|
/**
|
1093
1441
|
* AuthenticationType
|
1094
1442
|
* @description Below are the allowed values for the enumeration AuthenticationType.
|
1095
|
-
*
|
1096
|
-
*
|
1097
|
-
*
|
1443
|
+
* - OTP - One-time password generated by the Payer FSP.
|
1444
|
+
* - QRCODE - QR code used as One Time Password.
|
1445
|
+
* - U2F - U2F is a new addition isolated to Thirdparty stream.
|
1098
1446
|
* @example OTP
|
1099
1447
|
* @enum {string}
|
1100
1448
|
*/
|
@@ -1124,10 +1472,10 @@ export interface components {
|
|
1124
1472
|
/**
|
1125
1473
|
* TransactionRequestState
|
1126
1474
|
* @description Below are the allowed values for the enumeration.
|
1127
|
-
*
|
1128
|
-
*
|
1129
|
-
*
|
1130
|
-
*
|
1475
|
+
* - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
|
1476
|
+
* - PENDING - Payer FSP has sent the transaction request to the Payer.
|
1477
|
+
* - ACCEPTED - Payer has approved the transaction.
|
1478
|
+
* - REJECTED - Payer has rejected the transaction.
|
1131
1479
|
* @example RECEIVED
|
1132
1480
|
* @enum {string}
|
1133
1481
|
*/
|
@@ -1207,7 +1555,8 @@ export interface components {
|
|
1207
1555
|
body: components["schemas"]["QuotesIDPutResponse"];
|
1208
1556
|
headers?: Record<string, never>;
|
1209
1557
|
};
|
1210
|
-
/** @description FSPID of the entity that supplied the quote response. This may not be the same as the FSPID of the entity which owns the end user account in the case of a FOREX transfer. i.e. it may be a FOREX gateway.
|
1558
|
+
/** @description FSPID of the entity that supplied the quote response. This may not be the same as the FSPID of the entity which owns the end user account in the case of a FOREX transfer. i.e. it may be a FOREX gateway.
|
1559
|
+
* */
|
1211
1560
|
quoteResponseSource?: string;
|
1212
1561
|
fulfil?: {
|
1213
1562
|
body: components["schemas"]["TransfersIDPutResponse"];
|
@@ -1241,7 +1590,8 @@ export interface components {
|
|
1241
1590
|
* @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
|
1242
1591
|
*/
|
1243
1592
|
AuthenticationValue: string | {
|
1244
|
-
/** @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1593
|
+
/** @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1594
|
+
* */
|
1245
1595
|
pinValue: string;
|
1246
1596
|
/**
|
1247
1597
|
* Integer
|
@@ -1260,9 +1610,9 @@ export interface components {
|
|
1260
1610
|
/**
|
1261
1611
|
* AuthorizationResponseType
|
1262
1612
|
* @description Below are the allowed values for the enumeration.
|
1263
|
-
*
|
1264
|
-
*
|
1265
|
-
*
|
1613
|
+
* - ENTERED - Consumer entered the authentication value.
|
1614
|
+
* - REJECTED - Consumer rejected the transaction.
|
1615
|
+
* - RESEND - Consumer requested to resend the authentication value.
|
1266
1616
|
* @example ENTERED
|
1267
1617
|
* @enum {string}
|
1268
1618
|
*/
|
@@ -1293,7 +1643,8 @@ export interface components {
|
|
1293
1643
|
body: components["schemas"]["QuotesIDPutResponse"];
|
1294
1644
|
headers?: Record<string, never>;
|
1295
1645
|
};
|
1296
|
-
/** @description FSPID of the entity that supplied the quote response. This may not be the same as the FSPID of the entity which owns the end user account in the case of a FOREX transfer. i.e. it may be a FOREX gateway.
|
1646
|
+
/** @description FSPID of the entity that supplied the quote response. This may not be the same as the FSPID of the entity which owns the end user account in the case of a FOREX transfer. i.e. it may be a FOREX gateway.
|
1647
|
+
* */
|
1297
1648
|
quoteResponseSource?: string;
|
1298
1649
|
authorizationResponse?: {
|
1299
1650
|
body: components["schemas"]["AuthorizationIDPutResponse"];
|
@@ -1365,82 +1716,124 @@ export interface components {
|
|
1365
1716
|
responses: {
|
1366
1717
|
/** @description Accounts creation completed */
|
1367
1718
|
accountsCreationCompleted: {
|
1719
|
+
headers: {
|
1720
|
+
[name: string]: unknown;
|
1721
|
+
};
|
1368
1722
|
content: {
|
1369
1723
|
"application/json": components["schemas"]["accountsResponse"];
|
1370
1724
|
};
|
1371
1725
|
};
|
1372
1726
|
/** @description An error occurred creating accounts */
|
1373
1727
|
accountsCreationError: {
|
1728
|
+
headers: {
|
1729
|
+
[name: string]: unknown;
|
1730
|
+
};
|
1374
1731
|
content: {
|
1375
1732
|
"application/json": components["schemas"]["errorAccountsResponse"];
|
1376
1733
|
};
|
1377
1734
|
};
|
1378
1735
|
/** @description Timeout occurred creating accounts */
|
1379
1736
|
accountsCreationTimeout: {
|
1737
|
+
headers: {
|
1738
|
+
[name: string]: unknown;
|
1739
|
+
};
|
1380
1740
|
content: {
|
1381
1741
|
"application/json": components["schemas"]["errorAccountsResponse"];
|
1382
1742
|
};
|
1383
1743
|
};
|
1384
1744
|
/** @description Bulk quote completed successfully */
|
1385
1745
|
bulkQuoteSuccess: {
|
1746
|
+
headers: {
|
1747
|
+
[name: string]: unknown;
|
1748
|
+
};
|
1386
1749
|
content: {
|
1387
1750
|
"application/json": components["schemas"]["bulkQuoteResponse"];
|
1388
1751
|
};
|
1389
1752
|
};
|
1390
1753
|
/** @description Malformed or missing required body, headers or parameters */
|
1391
1754
|
bulkQuoteBadRequest: {
|
1755
|
+
headers: {
|
1756
|
+
[name: string]: unknown;
|
1757
|
+
};
|
1392
1758
|
content: {
|
1393
1759
|
"application/json": components["schemas"]["bulkQuoteErrorResponse"];
|
1394
1760
|
};
|
1395
1761
|
};
|
1396
1762
|
/** @description An error occurred processing the bulk quote */
|
1397
1763
|
bulkQuoteServerError: {
|
1764
|
+
headers: {
|
1765
|
+
[name: string]: unknown;
|
1766
|
+
};
|
1398
1767
|
content: {
|
1399
1768
|
"application/json": components["schemas"]["bulkQuoteErrorResponse"];
|
1400
1769
|
};
|
1401
1770
|
};
|
1402
1771
|
/** @description Timeout occurred processing the bulk quote */
|
1403
1772
|
bulkQuoteTimeout: {
|
1773
|
+
headers: {
|
1774
|
+
[name: string]: unknown;
|
1775
|
+
};
|
1404
1776
|
content: {
|
1405
1777
|
"application/json": components["schemas"]["bulkQuoteErrorResponse"];
|
1406
1778
|
};
|
1407
1779
|
};
|
1408
1780
|
/** @description Bulk transfer accepted successfully */
|
1409
1781
|
bulkTransactionAccepted: {
|
1410
|
-
|
1782
|
+
headers: {
|
1783
|
+
[name: string]: unknown;
|
1784
|
+
};
|
1785
|
+
content?: never;
|
1411
1786
|
};
|
1412
1787
|
/** @description Malformed or missing required body, headers or parameters */
|
1413
1788
|
bulkTransferBadRequest: {
|
1789
|
+
headers: {
|
1790
|
+
[name: string]: unknown;
|
1791
|
+
};
|
1414
1792
|
content: {
|
1415
1793
|
"application/json": components["schemas"]["bulkTransferErrorResponse"];
|
1416
1794
|
};
|
1417
1795
|
};
|
1418
1796
|
/** @description Internal Server Error */
|
1419
1797
|
errorResponse: {
|
1798
|
+
headers: {
|
1799
|
+
[name: string]: unknown;
|
1800
|
+
};
|
1420
1801
|
content: {
|
1421
1802
|
"application/json": components["schemas"]["errorResponse"];
|
1422
1803
|
};
|
1423
1804
|
};
|
1424
1805
|
/** @description Malformed or missing required body, headers or parameters */
|
1425
1806
|
bulkTransactionPutBadRequest: {
|
1807
|
+
headers: {
|
1808
|
+
[name: string]: unknown;
|
1809
|
+
};
|
1426
1810
|
content: {
|
1427
1811
|
"application/json": components["schemas"]["bulkTransactionAcceptPartyErrorResponse"] | components["schemas"]["bulkTransactionAcceptQuoteErrorResponse"];
|
1428
1812
|
};
|
1429
1813
|
};
|
1430
1814
|
/** @description Bulk transfer completed successfully */
|
1431
1815
|
bulkTransferSuccess: {
|
1816
|
+
headers: {
|
1817
|
+
[name: string]: unknown;
|
1818
|
+
};
|
1432
1819
|
content: {
|
1433
1820
|
"application/json": components["schemas"]["bulkTransferResponse"];
|
1434
1821
|
};
|
1435
1822
|
};
|
1436
1823
|
/** @description PartiesByIdSuccess */
|
1437
1824
|
partiesByIdSuccess: {
|
1825
|
+
headers: {
|
1826
|
+
[name: string]: unknown;
|
1827
|
+
};
|
1438
1828
|
content: {
|
1439
1829
|
"application/json": components["schemas"]["partiesByIdResponse"];
|
1440
1830
|
};
|
1441
1831
|
};
|
1442
1832
|
/** @description PartiesByIdError404 */
|
1443
1833
|
partiesByIdError404: {
|
1834
|
+
headers: {
|
1835
|
+
[name: string]: unknown;
|
1836
|
+
};
|
1444
1837
|
content: {
|
1445
1838
|
"application/json": {
|
1446
1839
|
errorInformation?: components["schemas"]["ErrorInformation"];
|
@@ -1449,66 +1842,99 @@ export interface components {
|
|
1449
1842
|
};
|
1450
1843
|
/** @description sync response from POST /quotes */
|
1451
1844
|
quotesPostSuccess: {
|
1845
|
+
headers: {
|
1846
|
+
[name: string]: unknown;
|
1847
|
+
};
|
1452
1848
|
content: {
|
1453
1849
|
"application/json": components["schemas"]["quotesPostResponse"];
|
1454
1850
|
};
|
1455
1851
|
};
|
1456
1852
|
/** @description An error occurred processing the quotes request */
|
1457
1853
|
quotesServerError: {
|
1854
|
+
headers: {
|
1855
|
+
[name: string]: unknown;
|
1856
|
+
};
|
1458
1857
|
content: {
|
1459
1858
|
"application/json": components["schemas"]["errorQuotesResponse"];
|
1460
1859
|
};
|
1461
1860
|
};
|
1462
1861
|
/** @description Request to Pay completed successfully */
|
1463
1862
|
requestToPaySuccess: {
|
1863
|
+
headers: {
|
1864
|
+
[name: string]: unknown;
|
1865
|
+
};
|
1464
1866
|
content: {
|
1465
1867
|
"application/json": components["schemas"]["requestToPayResponse"];
|
1466
1868
|
};
|
1467
1869
|
};
|
1468
1870
|
/** @description An error occurred processing the transfer */
|
1469
1871
|
transferServerError: {
|
1872
|
+
headers: {
|
1873
|
+
[name: string]: unknown;
|
1874
|
+
};
|
1470
1875
|
content: {
|
1471
1876
|
"application/json": components["schemas"]["errorTransferResponse"];
|
1472
1877
|
};
|
1473
1878
|
};
|
1474
1879
|
/** @description Timeout occurred processing the transfer */
|
1475
1880
|
transferTimeout: {
|
1881
|
+
headers: {
|
1882
|
+
[name: string]: unknown;
|
1883
|
+
};
|
1476
1884
|
content: {
|
1477
1885
|
"application/json": components["schemas"]["errorTransferResponse"];
|
1478
1886
|
};
|
1479
1887
|
};
|
1480
1888
|
/** @description Transfer completed successfully */
|
1481
1889
|
requestToPayTransferSuccess: {
|
1890
|
+
headers: {
|
1891
|
+
[name: string]: unknown;
|
1892
|
+
};
|
1482
1893
|
content: {
|
1483
1894
|
"application/json": components["schemas"]["requestToPayTransferResponse"];
|
1484
1895
|
};
|
1485
1896
|
};
|
1486
1897
|
/** @description Malformed or missing required body, headers or parameters */
|
1487
1898
|
requestToPayTransferBadRequest: {
|
1899
|
+
headers: {
|
1900
|
+
[name: string]: unknown;
|
1901
|
+
};
|
1488
1902
|
content: {
|
1489
1903
|
"application/json": components["schemas"]["errorTransferResponse"];
|
1490
1904
|
};
|
1491
1905
|
};
|
1492
1906
|
/** @description Transfer completed successfully */
|
1493
1907
|
transferSuccess: {
|
1908
|
+
headers: {
|
1909
|
+
[name: string]: unknown;
|
1910
|
+
};
|
1494
1911
|
content: {
|
1495
1912
|
"application/json": components["schemas"]["transferResponse"];
|
1496
1913
|
};
|
1497
1914
|
};
|
1498
1915
|
/** @description sync response from POST /simpleTransfers */
|
1499
1916
|
simpleTransfersPostSuccess: {
|
1917
|
+
headers: {
|
1918
|
+
[name: string]: unknown;
|
1919
|
+
};
|
1500
1920
|
content: {
|
1501
1921
|
"application/json": components["schemas"]["simpleTransfersPostResponse"];
|
1502
1922
|
};
|
1503
1923
|
};
|
1504
1924
|
/** @description An error occurred processing the simple transfers request */
|
1505
1925
|
simpleTransfersServerError: {
|
1926
|
+
headers: {
|
1927
|
+
[name: string]: unknown;
|
1928
|
+
};
|
1506
1929
|
content: {
|
1507
1930
|
"application/json": components["schemas"]["errorSimpleTransfersResponse"];
|
1508
1931
|
};
|
1509
1932
|
};
|
1510
1933
|
/** @description Malformed or missing required body, headers or parameters */
|
1511
1934
|
transferBadRequest: {
|
1935
|
+
headers: {
|
1936
|
+
[name: string]: unknown;
|
1937
|
+
};
|
1512
1938
|
content: {
|
1513
1939
|
"application/json": components["schemas"]["errorTransferResponse"];
|
1514
1940
|
};
|
@@ -1537,46 +1963,52 @@ export interface components {
|
|
1537
1963
|
pathItems: never;
|
1538
1964
|
}
|
1539
1965
|
export type $defs = Record<string, never>;
|
1540
|
-
export type external = Record<string, never>;
|
1541
1966
|
export interface operations {
|
1542
|
-
/**
|
1543
|
-
* PartiesByTypeAndID
|
1544
|
-
* @description The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
|
1545
|
-
*/
|
1546
1967
|
PartiesByTypeAndID: {
|
1547
1968
|
parameters: {
|
1969
|
+
query?: never;
|
1970
|
+
header?: never;
|
1548
1971
|
path: {
|
1972
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1549
1973
|
Type: components["parameters"]["Type"];
|
1974
|
+
/** @description The identifier value. */
|
1550
1975
|
ID: components["parameters"]["ID"];
|
1551
1976
|
};
|
1977
|
+
cookie?: never;
|
1552
1978
|
};
|
1979
|
+
requestBody?: never;
|
1553
1980
|
responses: {
|
1554
1981
|
200: components["responses"]["partiesByIdSuccess"];
|
1555
1982
|
404: components["responses"]["partiesByIdError404"];
|
1556
1983
|
};
|
1557
1984
|
};
|
1558
|
-
/**
|
1559
|
-
* PartiesSubIdByTypeAndID
|
1560
|
-
* @description The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
|
1561
|
-
*/
|
1562
1985
|
PartiesSubIdByTypeAndID: {
|
1563
1986
|
parameters: {
|
1987
|
+
query?: never;
|
1988
|
+
header?: never;
|
1564
1989
|
path: {
|
1990
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1565
1991
|
Type: components["parameters"]["Type"];
|
1992
|
+
/** @description The identifier value. */
|
1566
1993
|
ID: components["parameters"]["ID"];
|
1994
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1567
1995
|
SubId: components["parameters"]["SubId"];
|
1568
1996
|
};
|
1997
|
+
cookie?: never;
|
1569
1998
|
};
|
1999
|
+
requestBody?: never;
|
1570
2000
|
responses: {
|
1571
2001
|
200: components["responses"]["partiesByIdSuccess"];
|
1572
2002
|
404: components["responses"]["partiesByIdError404"];
|
1573
2003
|
};
|
1574
2004
|
};
|
1575
|
-
/**
|
1576
|
-
* Quotes endpoint
|
1577
|
-
* @description is used to request quotes from other DFSP
|
1578
|
-
*/
|
1579
2005
|
QuotesPost: {
|
2006
|
+
parameters: {
|
2007
|
+
query?: never;
|
2008
|
+
header?: never;
|
2009
|
+
path?: never;
|
2010
|
+
cookie?: never;
|
2011
|
+
};
|
1580
2012
|
/** @description Quotes request payload */
|
1581
2013
|
requestBody: {
|
1582
2014
|
content: {
|
@@ -1588,11 +2020,13 @@ export interface operations {
|
|
1588
2020
|
500: components["responses"]["quotesServerError"];
|
1589
2021
|
};
|
1590
2022
|
};
|
1591
|
-
/**
|
1592
|
-
* Simple Transfers endpoint
|
1593
|
-
* @description is used to request a transfer
|
1594
|
-
*/
|
1595
2023
|
SimpleTransfersPost: {
|
2024
|
+
parameters: {
|
2025
|
+
query?: never;
|
2026
|
+
header?: never;
|
2027
|
+
path?: never;
|
2028
|
+
cookie?: never;
|
2029
|
+
};
|
1596
2030
|
/** @description Simple Transfer request payload */
|
1597
2031
|
requestBody: {
|
1598
2032
|
content: {
|