@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,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 and/or conversion
|
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 and/or currency conversion stage.
|
405
742
|
*
|
406
|
-
*
|
743
|
+
* The request body should contain either the "acceptParty" or "acceptQuote" or "acceptConversion" 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,34 +766,92 @@ 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
|
"/services/FXP": {
|
777
|
+
parameters: {
|
778
|
+
query?: never;
|
779
|
+
header?: never;
|
780
|
+
path?: never;
|
781
|
+
cookie?: never;
|
782
|
+
};
|
429
783
|
/**
|
430
784
|
* Obtain a list of the DFSPs in the scheme who provide FXP service
|
431
785
|
* @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services.
|
432
786
|
*/
|
433
787
|
get: operations["ServicesFXPGet"];
|
788
|
+
put?: never;
|
789
|
+
post?: never;
|
790
|
+
delete?: never;
|
791
|
+
options?: never;
|
792
|
+
head?: never;
|
793
|
+
patch?: never;
|
794
|
+
trace?: never;
|
434
795
|
};
|
435
796
|
"/services/FXP/{SourceCurrency}/{TargetCurrency}": {
|
797
|
+
parameters: {
|
798
|
+
query?: never;
|
799
|
+
header?: never;
|
800
|
+
path?: never;
|
801
|
+
cookie?: never;
|
802
|
+
};
|
436
803
|
/**
|
437
804
|
* Obtain a list of the DFSPs in the scheme who provide FXP service
|
438
805
|
* @description The HTTP request `GET /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to request information about the participants in a scheme who offer currency conversion services in a particular currency corridor. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency.
|
439
806
|
*/
|
440
807
|
get: operations["ServicesFXPSourceCurrencyTargetCurrencyGet"];
|
808
|
+
put?: never;
|
809
|
+
post?: never;
|
810
|
+
delete?: never;
|
811
|
+
options?: never;
|
812
|
+
head?: never;
|
813
|
+
patch?: never;
|
814
|
+
trace?: never;
|
441
815
|
};
|
442
816
|
"/fxQuotes": {
|
817
|
+
parameters: {
|
818
|
+
query?: never;
|
819
|
+
header?: never;
|
820
|
+
path?: never;
|
821
|
+
cookie?: never;
|
822
|
+
};
|
823
|
+
get?: never;
|
824
|
+
put?: never;
|
443
825
|
/**
|
444
826
|
* Calculate FX quote
|
445
827
|
* @description The HTTP request `POST /fxQuotes` is used to ask to provide a quotation for a currency conversion.
|
446
828
|
*/
|
447
829
|
post: operations["FxQuotesPost"];
|
830
|
+
delete?: never;
|
831
|
+
options?: never;
|
832
|
+
head?: never;
|
833
|
+
patch?: never;
|
834
|
+
trace?: never;
|
448
835
|
};
|
449
836
|
"/fxTransfers": {
|
837
|
+
parameters: {
|
838
|
+
query?: never;
|
839
|
+
header?: never;
|
840
|
+
path?: never;
|
841
|
+
cookie?: never;
|
842
|
+
};
|
843
|
+
get?: never;
|
844
|
+
put?: never;
|
450
845
|
/**
|
451
846
|
* Perform FX transfer
|
452
847
|
* @description The HTTP request `POST /fxTransfers` is used to ask to confirm the execution of an agreed currency conversion.
|
453
848
|
*/
|
454
849
|
post: operations["FxTransfersPost"];
|
850
|
+
delete?: never;
|
851
|
+
options?: never;
|
852
|
+
head?: never;
|
853
|
+
patch?: never;
|
854
|
+
trace?: never;
|
455
855
|
};
|
456
856
|
}
|
457
857
|
export type webhooks = Record<string, never>;
|
@@ -460,14 +860,14 @@ export interface components {
|
|
460
860
|
/**
|
461
861
|
* PartyIdType
|
462
862
|
* @description Below are the allowed values for the enumeration.
|
463
|
-
*
|
464
|
-
*
|
465
|
-
*
|
466
|
-
*
|
467
|
-
*
|
468
|
-
*
|
469
|
-
*
|
470
|
-
*
|
863
|
+
* - 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.
|
864
|
+
* - 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).
|
865
|
+
* - 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.
|
866
|
+
* - 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.
|
867
|
+
* - 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.
|
868
|
+
* - 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.
|
869
|
+
* - 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.
|
870
|
+
* - 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.
|
471
871
|
* @enum {string}
|
472
872
|
*/
|
473
873
|
PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
|
@@ -501,10 +901,9 @@ export interface components {
|
|
501
901
|
*/
|
502
902
|
CorrelationId: string;
|
503
903
|
errorResponse: {
|
504
|
-
/**
|
505
|
-
*
|
506
|
-
*
|
507
|
-
*/
|
904
|
+
/** @description Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.
|
905
|
+
* Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
|
906
|
+
* */
|
508
907
|
statusCode?: string;
|
509
908
|
/** @description Error message text. */
|
510
909
|
message?: string;
|
@@ -589,10 +988,10 @@ export interface components {
|
|
589
988
|
/**
|
590
989
|
* TransactionInitiatorType
|
591
990
|
* @description Below are the allowed values for the enumeration.
|
592
|
-
*
|
593
|
-
*
|
594
|
-
*
|
595
|
-
*
|
991
|
+
* - CONSUMER - Consumer is the initiator of the transaction.
|
992
|
+
* - AGENT - Agent is the initiator of the transaction.
|
993
|
+
* - BUSINESS - Business is the initiator of the transaction.
|
994
|
+
* - DEVICE - Device is the initiator of the transaction.
|
596
995
|
* @example CONSUMER
|
597
996
|
* @enum {string}
|
598
997
|
*/
|
@@ -601,9 +1000,9 @@ export interface components {
|
|
601
1000
|
* Name
|
602
1001
|
* @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.
|
603
1002
|
*
|
604
|
-
*
|
1003
|
+
* 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 ( ).
|
605
1004
|
*
|
606
|
-
*
|
1005
|
+
* **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.
|
607
1006
|
*/
|
608
1007
|
Name: string;
|
609
1008
|
/**
|
@@ -644,32 +1043,32 @@ export interface components {
|
|
644
1043
|
* KYCInformation
|
645
1044
|
* @description KYC information for the party in a form mandated by an individual scheme.
|
646
1045
|
* @example {
|
647
|
-
*
|
648
|
-
*
|
649
|
-
*
|
650
|
-
*
|
651
|
-
*
|
652
|
-
*
|
653
|
-
*
|
654
|
-
*
|
655
|
-
*
|
656
|
-
*
|
657
|
-
*
|
658
|
-
*
|
659
|
-
*
|
660
|
-
*
|
661
|
-
*
|
662
|
-
*
|
663
|
-
*
|
664
|
-
*
|
665
|
-
*
|
666
|
-
*
|
667
|
-
*
|
668
|
-
*
|
669
|
-
*
|
670
|
-
*
|
1046
|
+
* "metadata": {
|
1047
|
+
* "format": "JSON",
|
1048
|
+
* "version": "1.0",
|
1049
|
+
* "description": "Data containing KYC Information"
|
1050
|
+
* },
|
1051
|
+
* "data": {
|
1052
|
+
* "name": "John Doe",
|
1053
|
+
* "dob": "1980-05-15",
|
1054
|
+
* "gender": "Male",
|
1055
|
+
* "address": "123 Main Street, Anytown, USA",
|
1056
|
+
* "email": "johndoe@example.com",
|
1057
|
+
* "phone": "+1 555-123-4567",
|
1058
|
+
* "nationality": "US",
|
1059
|
+
* "passport_number": "AB1234567",
|
1060
|
+
* "issue_date": "2010-02-20",
|
1061
|
+
* "expiry_date": "2025-02-20",
|
1062
|
+
* "bank_account_number": "1234567890",
|
1063
|
+
* "bank_name": "Example Bank",
|
1064
|
+
* "employer": "ABC Company",
|
1065
|
+
* "occupation": "Software Engineer",
|
1066
|
+
* "income": "$80,000 per year",
|
1067
|
+
* "marital_status": "Single",
|
1068
|
+
* "dependents": 0,
|
1069
|
+
* "risk_level": "Low"
|
1070
|
+
* }
|
671
1071
|
* }
|
672
|
-
* }
|
673
1072
|
*/
|
674
1073
|
KYCInformation: string;
|
675
1074
|
extensionListEmptiable: components["schemas"]["Extension"][];
|
@@ -693,8 +1092,8 @@ export interface components {
|
|
693
1092
|
/**
|
694
1093
|
* AmountType
|
695
1094
|
* @description Below are the allowed values for the enumeration AmountType.
|
696
|
-
*
|
697
|
-
*
|
1095
|
+
* - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
1096
|
+
* - 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.
|
698
1097
|
* @example RECEIVE
|
699
1098
|
* @enum {string}
|
700
1099
|
*/
|
@@ -934,10 +1333,10 @@ export interface components {
|
|
934
1333
|
/**
|
935
1334
|
* TransferState
|
936
1335
|
* @description Below are the allowed values for the enumeration.
|
937
|
-
*
|
938
|
-
*
|
939
|
-
*
|
940
|
-
*
|
1336
|
+
* - RECEIVED - Next ledger has received the transfer.
|
1337
|
+
* - RESERVED - Next ledger has reserved the transfer.
|
1338
|
+
* - COMMITTED - Next ledger has successfully performed the transfer.
|
1339
|
+
* - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
|
941
1340
|
* @example RESERVED
|
942
1341
|
* @enum {string}
|
943
1342
|
*/
|
@@ -998,12 +1397,12 @@ export interface components {
|
|
998
1397
|
httpStatusCode?: number;
|
999
1398
|
mojaloopError?: components["schemas"]["mojaloopError"];
|
1000
1399
|
};
|
1001
|
-
bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] &
|
1400
|
+
bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] & {
|
1002
1401
|
bulkTransferState: components["schemas"]["bulkTransactionContinuationAcceptParty"] & components["schemas"]["partyError"];
|
1003
|
-
}
|
1004
|
-
bulkTransactionAcceptQuoteErrorResponse: components["schemas"]["errorResponse"] &
|
1402
|
+
};
|
1403
|
+
bulkTransactionAcceptQuoteErrorResponse: components["schemas"]["errorResponse"] & {
|
1005
1404
|
bulkTransferState?: components["schemas"]["bulkTransactionContinuationAcceptQuote"] & components["schemas"]["quoteError"];
|
1006
|
-
}
|
1405
|
+
};
|
1007
1406
|
/**
|
1008
1407
|
* IndividualTransfer
|
1009
1408
|
* @description Data model for the complex type 'individualTransfer'.
|
@@ -1057,11 +1456,11 @@ export interface components {
|
|
1057
1456
|
/**
|
1058
1457
|
* TransactionScenario
|
1059
1458
|
* @description Below are the allowed values for the enumeration.
|
1060
|
-
*
|
1061
|
-
*
|
1062
|
-
*
|
1063
|
-
*
|
1064
|
-
*
|
1459
|
+
* - 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.
|
1460
|
+
* - 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.
|
1461
|
+
* - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
1462
|
+
* - 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.
|
1463
|
+
* - REFUND - Used for performing a refund of transaction.
|
1065
1464
|
* @example DEPOSIT
|
1066
1465
|
* @enum {string}
|
1067
1466
|
*/
|
@@ -1069,8 +1468,8 @@ export interface components {
|
|
1069
1468
|
/**
|
1070
1469
|
* TransactionInitiator
|
1071
1470
|
* @description Below are the allowed values for the enumeration.
|
1072
|
-
*
|
1073
|
-
*
|
1471
|
+
* - 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.
|
1472
|
+
* - 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.
|
1074
1473
|
* @example PAYEE
|
1075
1474
|
* @enum {string}
|
1076
1475
|
*/
|
@@ -1118,8 +1517,8 @@ export interface components {
|
|
1118
1517
|
* @description The FxRate object contains information about a currency conversion in the transfer. It can be used by parties to the transfer to exchange information with each other about the exchange rate for the transfer, to ensure that the best rate can be agreed on.
|
1119
1518
|
*/
|
1120
1519
|
FxRate: {
|
1121
|
-
sourceAmount: components["schemas"]["Money"];
|
1122
|
-
targetAmount: components["schemas"]["Money"];
|
1520
|
+
sourceAmount: components["schemas"]["Money"] & unknown;
|
1521
|
+
targetAmount: components["schemas"]["Money"] & unknown;
|
1123
1522
|
};
|
1124
1523
|
/**
|
1125
1524
|
* QuotesPostRequest
|
@@ -1135,8 +1534,8 @@ export interface components {
|
|
1135
1534
|
amount: components["schemas"]["Money"];
|
1136
1535
|
fees?: components["schemas"]["Money"];
|
1137
1536
|
transactionType: components["schemas"]["TransactionType"];
|
1138
|
-
converter?: components["schemas"]["CurrencyConverter"];
|
1139
|
-
currencyConversion?: components["schemas"]["FxRate"];
|
1537
|
+
converter?: components["schemas"]["CurrencyConverter"] & unknown;
|
1538
|
+
currencyConversion?: components["schemas"]["FxRate"] & unknown;
|
1140
1539
|
geoCode?: components["schemas"]["GeoCode"];
|
1141
1540
|
note?: components["schemas"]["Note"];
|
1142
1541
|
expiration?: components["schemas"]["DateTime"];
|
@@ -1177,9 +1576,9 @@ export interface components {
|
|
1177
1576
|
/**
|
1178
1577
|
* AuthenticationType
|
1179
1578
|
* @description Below are the allowed values for the enumeration AuthenticationType.
|
1180
|
-
*
|
1181
|
-
*
|
1182
|
-
*
|
1579
|
+
* - OTP - One-time password generated by the Payer FSP.
|
1580
|
+
* - QRCODE - QR code used as One Time Password.
|
1581
|
+
* - U2F - U2F is a new addition isolated to Thirdparty stream.
|
1183
1582
|
* @example OTP
|
1184
1583
|
* @enum {string}
|
1185
1584
|
*/
|
@@ -1209,10 +1608,10 @@ export interface components {
|
|
1209
1608
|
/**
|
1210
1609
|
* TransactionRequestState
|
1211
1610
|
* @description Below are the allowed values for the enumeration.
|
1212
|
-
*
|
1213
|
-
*
|
1214
|
-
*
|
1215
|
-
*
|
1611
|
+
* - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
|
1612
|
+
* - PENDING - Payer FSP has sent the transaction request to the Payer.
|
1613
|
+
* - ACCEPTED - Payer has approved the transaction.
|
1614
|
+
* - REJECTED - Payer has rejected the transaction.
|
1216
1615
|
* @example RECEIVED
|
1217
1616
|
* @enum {string}
|
1218
1617
|
*/
|
@@ -1275,25 +1674,25 @@ export interface components {
|
|
1275
1674
|
FxCharge: {
|
1276
1675
|
/** @description A description of the charge which is being levied. */
|
1277
1676
|
chargeType: string;
|
1278
|
-
sourceAmount?: components["schemas"]["Money"];
|
1279
|
-
targetAmount?: components["schemas"]["Money"];
|
1677
|
+
sourceAmount?: components["schemas"]["Money"] & unknown;
|
1678
|
+
targetAmount?: components["schemas"]["Money"] & unknown;
|
1280
1679
|
};
|
1281
1680
|
/**
|
1282
1681
|
* FxConversion
|
1283
1682
|
* @description A DFSP will be able to request a currency conversion, and an FX provider will be able to describe its involvement in a proposed transfer, using a FxConversion object.
|
1284
1683
|
*/
|
1285
1684
|
FxConversion: {
|
1286
|
-
conversionId: components["schemas"]["CorrelationId"];
|
1287
|
-
determiningTransferId?: components["schemas"]["CorrelationId"];
|
1288
|
-
initiatingFsp: components["schemas"]["FspId"];
|
1289
|
-
counterPartyFsp: components["schemas"]["FspId"];
|
1290
|
-
amountType: components["schemas"]["AmountType"];
|
1291
|
-
sourceAmount: components["schemas"]["FxMoney"];
|
1292
|
-
targetAmount: components["schemas"]["FxMoney"];
|
1293
|
-
expiration: components["schemas"]["DateTime"];
|
1685
|
+
conversionId: components["schemas"]["CorrelationId"] & unknown;
|
1686
|
+
determiningTransferId?: components["schemas"]["CorrelationId"] & unknown;
|
1687
|
+
initiatingFsp: components["schemas"]["FspId"] & unknown;
|
1688
|
+
counterPartyFsp: components["schemas"]["FspId"] & unknown;
|
1689
|
+
amountType: components["schemas"]["AmountType"] & unknown;
|
1690
|
+
sourceAmount: components["schemas"]["FxMoney"] & unknown;
|
1691
|
+
targetAmount: components["schemas"]["FxMoney"] & unknown;
|
1692
|
+
expiration: components["schemas"]["DateTime"] & unknown;
|
1294
1693
|
/** @description One or more charges which the FXP intends to levy as part of the currency conversion, or which the payee DFSP intends to add to the amount transferred. */
|
1295
1694
|
charges?: components["schemas"]["FxCharge"][];
|
1296
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
1695
|
+
extensionList?: components["schemas"]["ExtensionList"] & unknown;
|
1297
1696
|
};
|
1298
1697
|
/**
|
1299
1698
|
* FxQuotesPostOutboundResponse
|
@@ -1302,8 +1701,8 @@ export interface components {
|
|
1302
1701
|
FxQuotesPostOutboundResponse: {
|
1303
1702
|
/** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */
|
1304
1703
|
homeTransactionId?: string;
|
1305
|
-
condition?: components["schemas"]["IlpCondition"];
|
1306
|
-
conversionTerms: components["schemas"]["FxConversion"];
|
1704
|
+
condition?: components["schemas"]["IlpCondition"] & unknown;
|
1705
|
+
conversionTerms: components["schemas"]["FxConversion"] & unknown;
|
1307
1706
|
};
|
1308
1707
|
/**
|
1309
1708
|
* TransfersIDPutResponse
|
@@ -1337,14 +1736,16 @@ export interface components {
|
|
1337
1736
|
body: components["schemas"]["QuotesIDPutResponse"];
|
1338
1737
|
headers?: Record<string, never>;
|
1339
1738
|
};
|
1340
|
-
/** @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.
|
1739
|
+
/** @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.
|
1740
|
+
* */
|
1341
1741
|
quoteResponseSource?: string;
|
1342
1742
|
conversionRequestId?: components["schemas"]["CorrelationId"];
|
1343
1743
|
fxQuotesResponse?: {
|
1344
1744
|
body: components["schemas"]["FxQuotesPostOutboundResponse"];
|
1345
1745
|
headers?: Record<string, never>;
|
1346
1746
|
};
|
1347
|
-
/** @description FXPID of the entity that supplied the fxQuotes response.
|
1747
|
+
/** @description FXPID of the entity that supplied the fxQuotes response.
|
1748
|
+
* */
|
1348
1749
|
fxQuotesResponseSource?: string;
|
1349
1750
|
fulfil?: {
|
1350
1751
|
body: components["schemas"]["TransfersIDPutResponse"];
|
@@ -1378,7 +1779,8 @@ export interface components {
|
|
1378
1779
|
* @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
|
1379
1780
|
*/
|
1380
1781
|
AuthenticationValue: string | {
|
1381
|
-
/** @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1782
|
+
/** @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1783
|
+
* */
|
1382
1784
|
pinValue: string;
|
1383
1785
|
/**
|
1384
1786
|
* Integer
|
@@ -1397,9 +1799,9 @@ export interface components {
|
|
1397
1799
|
/**
|
1398
1800
|
* AuthorizationResponseType
|
1399
1801
|
* @description Below are the allowed values for the enumeration.
|
1400
|
-
*
|
1401
|
-
*
|
1402
|
-
*
|
1802
|
+
* - ENTERED - Consumer entered the authentication value.
|
1803
|
+
* - REJECTED - Consumer rejected the transaction.
|
1804
|
+
* - RESEND - Consumer requested to resend the authentication value.
|
1403
1805
|
* @example ENTERED
|
1404
1806
|
* @enum {string}
|
1405
1807
|
*/
|
@@ -1430,7 +1832,8 @@ export interface components {
|
|
1430
1832
|
body: components["schemas"]["QuotesIDPutResponse"];
|
1431
1833
|
headers?: Record<string, never>;
|
1432
1834
|
};
|
1433
|
-
/** @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.
|
1835
|
+
/** @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.
|
1836
|
+
* */
|
1434
1837
|
quoteResponseSource?: string;
|
1435
1838
|
authorizationResponse?: {
|
1436
1839
|
body: components["schemas"]["AuthorizationIDPutResponse"];
|
@@ -1517,16 +1920,16 @@ export interface components {
|
|
1517
1920
|
FxQuotesPostOutboundRequest: {
|
1518
1921
|
/** @description Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems. */
|
1519
1922
|
homeTransactionId?: string;
|
1520
|
-
conversionRequestId: components["schemas"]["CorrelationId"];
|
1521
|
-
conversionTerms: components["schemas"]["FxConversion"];
|
1923
|
+
conversionRequestId: components["schemas"]["CorrelationId"] & unknown;
|
1924
|
+
conversionTerms: components["schemas"]["FxConversion"] & unknown;
|
1522
1925
|
};
|
1523
|
-
commitRequestId: components["schemas"]["CorrelationId"];
|
1524
|
-
determiningTransferId: components["schemas"]["CorrelationId"];
|
1525
|
-
initiatingFsp: components["schemas"]["FspId"];
|
1526
|
-
counterPartyFsp: components["schemas"]["FspId"];
|
1527
|
-
sourceAmount: components["schemas"]["Money"];
|
1528
|
-
targetAmount: components["schemas"]["Money"];
|
1529
|
-
condition: components["schemas"]["IlpCondition"];
|
1926
|
+
commitRequestId: components["schemas"]["CorrelationId"] & unknown;
|
1927
|
+
determiningTransferId: components["schemas"]["CorrelationId"] & unknown;
|
1928
|
+
initiatingFsp: components["schemas"]["FspId"] & unknown;
|
1929
|
+
counterPartyFsp: components["schemas"]["FspId"] & unknown;
|
1930
|
+
sourceAmount: components["schemas"]["Money"] & unknown;
|
1931
|
+
targetAmount: components["schemas"]["Money"] & unknown;
|
1932
|
+
condition: components["schemas"]["IlpCondition"] & unknown;
|
1530
1933
|
/**
|
1531
1934
|
* FxTransfersPostOutboundRequest
|
1532
1935
|
* @description The object sent in the POST /fxTransfers request.
|
@@ -1542,9 +1945,9 @@ export interface components {
|
|
1542
1945
|
targetAmount: components["schemas"]["targetAmount"];
|
1543
1946
|
condition?: components["schemas"]["condition"];
|
1544
1947
|
};
|
1545
|
-
fulfilment: components["schemas"]["IlpFulfilment"];
|
1546
|
-
completedTimestamp: components["schemas"]["DateTime"];
|
1547
|
-
conversionState: components["schemas"]["TransferState"];
|
1948
|
+
fulfilment: components["schemas"]["IlpFulfilment"] & unknown;
|
1949
|
+
completedTimestamp: components["schemas"]["DateTime"] & unknown;
|
1950
|
+
conversionState: components["schemas"]["TransferState"] & unknown;
|
1548
1951
|
/**
|
1549
1952
|
* FxTransfersPostOutboundResponse
|
1550
1953
|
* @description The object sent as a response for the POST /fxTransfers request.
|
@@ -1561,94 +1964,142 @@ export interface components {
|
|
1561
1964
|
responses: {
|
1562
1965
|
/** @description Malformed or missing required headers or parameters. */
|
1563
1966
|
400: {
|
1967
|
+
headers: {
|
1968
|
+
[name: string]: unknown;
|
1969
|
+
};
|
1564
1970
|
content: {
|
1565
1971
|
"application/json": components["schemas"]["errorResponse"];
|
1566
1972
|
};
|
1567
1973
|
};
|
1568
1974
|
/** @description An error occurred processing the request. */
|
1569
1975
|
500: {
|
1976
|
+
headers: {
|
1977
|
+
[name: string]: unknown;
|
1978
|
+
};
|
1570
1979
|
content: {
|
1571
1980
|
"application/json": components["schemas"]["errorResponse"];
|
1572
1981
|
};
|
1573
1982
|
};
|
1574
1983
|
/** @description Accounts creation completed */
|
1575
1984
|
accountsCreationCompleted: {
|
1985
|
+
headers: {
|
1986
|
+
[name: string]: unknown;
|
1987
|
+
};
|
1576
1988
|
content: {
|
1577
1989
|
"application/json": components["schemas"]["accountsResponse"];
|
1578
1990
|
};
|
1579
1991
|
};
|
1580
1992
|
/** @description An error occurred creating accounts */
|
1581
1993
|
accountsCreationError: {
|
1994
|
+
headers: {
|
1995
|
+
[name: string]: unknown;
|
1996
|
+
};
|
1582
1997
|
content: {
|
1583
1998
|
"application/json": components["schemas"]["errorAccountsResponse"];
|
1584
1999
|
};
|
1585
2000
|
};
|
1586
2001
|
/** @description Timeout occurred creating accounts */
|
1587
2002
|
accountsCreationTimeout: {
|
2003
|
+
headers: {
|
2004
|
+
[name: string]: unknown;
|
2005
|
+
};
|
1588
2006
|
content: {
|
1589
2007
|
"application/json": components["schemas"]["errorAccountsResponse"];
|
1590
2008
|
};
|
1591
2009
|
};
|
1592
2010
|
/** @description Bulk quote completed successfully */
|
1593
2011
|
bulkQuoteSuccess: {
|
2012
|
+
headers: {
|
2013
|
+
[name: string]: unknown;
|
2014
|
+
};
|
1594
2015
|
content: {
|
1595
2016
|
"application/json": components["schemas"]["bulkQuoteResponse"];
|
1596
2017
|
};
|
1597
2018
|
};
|
1598
2019
|
/** @description Malformed or missing required body, headers or parameters */
|
1599
2020
|
bulkQuoteBadRequest: {
|
2021
|
+
headers: {
|
2022
|
+
[name: string]: unknown;
|
2023
|
+
};
|
1600
2024
|
content: {
|
1601
2025
|
"application/json": components["schemas"]["bulkQuoteErrorResponse"];
|
1602
2026
|
};
|
1603
2027
|
};
|
1604
2028
|
/** @description An error occurred processing the bulk quote */
|
1605
2029
|
bulkQuoteServerError: {
|
2030
|
+
headers: {
|
2031
|
+
[name: string]: unknown;
|
2032
|
+
};
|
1606
2033
|
content: {
|
1607
2034
|
"application/json": components["schemas"]["bulkQuoteErrorResponse"];
|
1608
2035
|
};
|
1609
2036
|
};
|
1610
2037
|
/** @description Timeout occurred processing the bulk quote */
|
1611
2038
|
bulkQuoteTimeout: {
|
2039
|
+
headers: {
|
2040
|
+
[name: string]: unknown;
|
2041
|
+
};
|
1612
2042
|
content: {
|
1613
2043
|
"application/json": components["schemas"]["bulkQuoteErrorResponse"];
|
1614
2044
|
};
|
1615
2045
|
};
|
1616
2046
|
/** @description Bulk transfer accepted successfully */
|
1617
2047
|
bulkTransactionAccepted: {
|
1618
|
-
|
2048
|
+
headers: {
|
2049
|
+
[name: string]: unknown;
|
2050
|
+
};
|
2051
|
+
content?: never;
|
1619
2052
|
};
|
1620
2053
|
/** @description Malformed or missing required body, headers or parameters */
|
1621
2054
|
bulkTransferBadRequest: {
|
2055
|
+
headers: {
|
2056
|
+
[name: string]: unknown;
|
2057
|
+
};
|
1622
2058
|
content: {
|
1623
2059
|
"application/json": components["schemas"]["bulkTransferErrorResponse"];
|
1624
2060
|
};
|
1625
2061
|
};
|
1626
2062
|
/** @description Internal Server Error */
|
1627
2063
|
errorResponse: {
|
2064
|
+
headers: {
|
2065
|
+
[name: string]: unknown;
|
2066
|
+
};
|
1628
2067
|
content: {
|
1629
2068
|
"application/json": components["schemas"]["errorResponse"];
|
1630
2069
|
};
|
1631
2070
|
};
|
1632
2071
|
/** @description Malformed or missing required body, headers or parameters */
|
1633
2072
|
bulkTransactionPutBadRequest: {
|
2073
|
+
headers: {
|
2074
|
+
[name: string]: unknown;
|
2075
|
+
};
|
1634
2076
|
content: {
|
1635
2077
|
"application/json": components["schemas"]["bulkTransactionAcceptPartyErrorResponse"] | components["schemas"]["bulkTransactionAcceptQuoteErrorResponse"];
|
1636
2078
|
};
|
1637
2079
|
};
|
1638
2080
|
/** @description Bulk transfer completed successfully */
|
1639
2081
|
bulkTransferSuccess: {
|
2082
|
+
headers: {
|
2083
|
+
[name: string]: unknown;
|
2084
|
+
};
|
1640
2085
|
content: {
|
1641
2086
|
"application/json": components["schemas"]["bulkTransferResponse"];
|
1642
2087
|
};
|
1643
2088
|
};
|
1644
2089
|
/** @description PartiesByIdSuccess */
|
1645
2090
|
partiesByIdSuccess: {
|
2091
|
+
headers: {
|
2092
|
+
[name: string]: unknown;
|
2093
|
+
};
|
1646
2094
|
content: {
|
1647
2095
|
"application/json": components["schemas"]["partiesByIdResponse"];
|
1648
2096
|
};
|
1649
2097
|
};
|
1650
2098
|
/** @description PartiesByIdError404 */
|
1651
2099
|
partiesByIdError404: {
|
2100
|
+
headers: {
|
2101
|
+
[name: string]: unknown;
|
2102
|
+
};
|
1652
2103
|
content: {
|
1653
2104
|
"application/json": {
|
1654
2105
|
errorInformation?: components["schemas"]["ErrorInformation"];
|
@@ -1657,72 +2108,108 @@ export interface components {
|
|
1657
2108
|
};
|
1658
2109
|
/** @description sync response from POST /quotes */
|
1659
2110
|
quotesPostSuccess: {
|
2111
|
+
headers: {
|
2112
|
+
[name: string]: unknown;
|
2113
|
+
};
|
1660
2114
|
content: {
|
1661
2115
|
"application/json": components["schemas"]["quotesPostResponse"];
|
1662
2116
|
};
|
1663
2117
|
};
|
1664
2118
|
/** @description An error occurred processing the quotes request */
|
1665
2119
|
quotesServerError: {
|
2120
|
+
headers: {
|
2121
|
+
[name: string]: unknown;
|
2122
|
+
};
|
1666
2123
|
content: {
|
1667
2124
|
"application/json": components["schemas"]["errorQuotesResponse"];
|
1668
2125
|
};
|
1669
2126
|
};
|
1670
2127
|
/** @description Request to Pay completed successfully */
|
1671
2128
|
requestToPaySuccess: {
|
2129
|
+
headers: {
|
2130
|
+
[name: string]: unknown;
|
2131
|
+
};
|
1672
2132
|
content: {
|
1673
2133
|
"application/json": components["schemas"]["requestToPayResponse"];
|
1674
2134
|
};
|
1675
2135
|
};
|
1676
2136
|
/** @description An error occurred processing the transfer */
|
1677
2137
|
transferServerError: {
|
2138
|
+
headers: {
|
2139
|
+
[name: string]: unknown;
|
2140
|
+
};
|
1678
2141
|
content: {
|
1679
2142
|
"application/json": components["schemas"]["errorTransferResponse"];
|
1680
2143
|
};
|
1681
2144
|
};
|
1682
2145
|
/** @description Timeout occurred processing the transfer */
|
1683
2146
|
transferTimeout: {
|
2147
|
+
headers: {
|
2148
|
+
[name: string]: unknown;
|
2149
|
+
};
|
1684
2150
|
content: {
|
1685
2151
|
"application/json": components["schemas"]["errorTransferResponse"];
|
1686
2152
|
};
|
1687
2153
|
};
|
1688
2154
|
/** @description Transfer completed successfully */
|
1689
2155
|
requestToPayTransferSuccess: {
|
2156
|
+
headers: {
|
2157
|
+
[name: string]: unknown;
|
2158
|
+
};
|
1690
2159
|
content: {
|
1691
2160
|
"application/json": components["schemas"]["requestToPayTransferResponse"];
|
1692
2161
|
};
|
1693
2162
|
};
|
1694
2163
|
/** @description Malformed or missing required body, headers or parameters */
|
1695
2164
|
requestToPayTransferBadRequest: {
|
2165
|
+
headers: {
|
2166
|
+
[name: string]: unknown;
|
2167
|
+
};
|
1696
2168
|
content: {
|
1697
2169
|
"application/json": components["schemas"]["errorTransferResponse"];
|
1698
2170
|
};
|
1699
2171
|
};
|
1700
2172
|
/** @description Transfer completed successfully */
|
1701
2173
|
transferSuccess: {
|
2174
|
+
headers: {
|
2175
|
+
[name: string]: unknown;
|
2176
|
+
};
|
1702
2177
|
content: {
|
1703
2178
|
"application/json": components["schemas"]["transferResponse"];
|
1704
2179
|
};
|
1705
2180
|
};
|
1706
2181
|
/** @description sync response from POST /simpleTransfers */
|
1707
2182
|
simpleTransfersPostSuccess: {
|
2183
|
+
headers: {
|
2184
|
+
[name: string]: unknown;
|
2185
|
+
};
|
1708
2186
|
content: {
|
1709
2187
|
"application/json": components["schemas"]["simpleTransfersPostResponse"];
|
1710
2188
|
};
|
1711
2189
|
};
|
1712
2190
|
/** @description An error occurred processing the simple transfers request */
|
1713
2191
|
simpleTransfersServerError: {
|
2192
|
+
headers: {
|
2193
|
+
[name: string]: unknown;
|
2194
|
+
};
|
1714
2195
|
content: {
|
1715
2196
|
"application/json": components["schemas"]["errorSimpleTransfersResponse"];
|
1716
2197
|
};
|
1717
2198
|
};
|
1718
2199
|
/** @description Malformed or missing required body, headers or parameters */
|
1719
2200
|
transferBadRequest: {
|
2201
|
+
headers: {
|
2202
|
+
[name: string]: unknown;
|
2203
|
+
};
|
1720
2204
|
content: {
|
1721
2205
|
"application/json": components["schemas"]["errorTransferResponse"];
|
1722
2206
|
};
|
1723
2207
|
};
|
1724
2208
|
/** @description The response contains participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. */
|
1725
2209
|
servicesFXPSucess: {
|
2210
|
+
headers: {
|
2211
|
+
[name: string]: unknown;
|
2212
|
+
};
|
1726
2213
|
content: {
|
1727
2214
|
"application/json": components["schemas"]["ServicesFXPPutResponse"];
|
1728
2215
|
};
|
@@ -1755,46 +2242,52 @@ export interface components {
|
|
1755
2242
|
pathItems: never;
|
1756
2243
|
}
|
1757
2244
|
export type $defs = Record<string, never>;
|
1758
|
-
export type external = Record<string, never>;
|
1759
2245
|
export interface operations {
|
1760
|
-
/**
|
1761
|
-
* PartiesByTypeAndID
|
1762
|
-
* @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).
|
1763
|
-
*/
|
1764
2246
|
PartiesByTypeAndID: {
|
1765
2247
|
parameters: {
|
2248
|
+
query?: never;
|
2249
|
+
header?: never;
|
1766
2250
|
path: {
|
2251
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1767
2252
|
Type: components["parameters"]["Type"];
|
2253
|
+
/** @description The identifier value. */
|
1768
2254
|
ID: components["parameters"]["ID"];
|
1769
2255
|
};
|
2256
|
+
cookie?: never;
|
1770
2257
|
};
|
2258
|
+
requestBody?: never;
|
1771
2259
|
responses: {
|
1772
2260
|
200: components["responses"]["partiesByIdSuccess"];
|
1773
2261
|
404: components["responses"]["partiesByIdError404"];
|
1774
2262
|
};
|
1775
2263
|
};
|
1776
|
-
/**
|
1777
|
-
* PartiesSubIdByTypeAndID
|
1778
|
-
* @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).
|
1779
|
-
*/
|
1780
2264
|
PartiesSubIdByTypeAndID: {
|
1781
2265
|
parameters: {
|
2266
|
+
query?: never;
|
2267
|
+
header?: never;
|
1782
2268
|
path: {
|
2269
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1783
2270
|
Type: components["parameters"]["Type"];
|
2271
|
+
/** @description The identifier value. */
|
1784
2272
|
ID: components["parameters"]["ID"];
|
2273
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1785
2274
|
SubId: components["parameters"]["SubId"];
|
1786
2275
|
};
|
2276
|
+
cookie?: never;
|
1787
2277
|
};
|
2278
|
+
requestBody?: never;
|
1788
2279
|
responses: {
|
1789
2280
|
200: components["responses"]["partiesByIdSuccess"];
|
1790
2281
|
404: components["responses"]["partiesByIdError404"];
|
1791
2282
|
};
|
1792
2283
|
};
|
1793
|
-
/**
|
1794
|
-
* Quotes endpoint
|
1795
|
-
* @description is used to request quotes from other DFSP
|
1796
|
-
*/
|
1797
2284
|
QuotesPost: {
|
2285
|
+
parameters: {
|
2286
|
+
query?: never;
|
2287
|
+
header?: never;
|
2288
|
+
path?: never;
|
2289
|
+
cookie?: never;
|
2290
|
+
};
|
1798
2291
|
/** @description Quotes request payload */
|
1799
2292
|
requestBody: {
|
1800
2293
|
content: {
|
@@ -1806,11 +2299,13 @@ export interface operations {
|
|
1806
2299
|
500: components["responses"]["quotesServerError"];
|
1807
2300
|
};
|
1808
2301
|
};
|
1809
|
-
/**
|
1810
|
-
* Simple Transfers endpoint
|
1811
|
-
* @description is used to request a transfer
|
1812
|
-
*/
|
1813
2302
|
SimpleTransfersPost: {
|
2303
|
+
parameters: {
|
2304
|
+
query?: never;
|
2305
|
+
header?: never;
|
2306
|
+
path?: never;
|
2307
|
+
cookie?: never;
|
2308
|
+
};
|
1814
2309
|
/** @description Simple Transfer request payload */
|
1815
2310
|
requestBody: {
|
1816
2311
|
content: {
|
@@ -1822,39 +2317,46 @@ export interface operations {
|
|
1822
2317
|
500: components["responses"]["simpleTransfersServerError"];
|
1823
2318
|
};
|
1824
2319
|
};
|
1825
|
-
/**
|
1826
|
-
* Obtain a list of the DFSPs in the scheme who provide FXP service
|
1827
|
-
* @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services.
|
1828
|
-
*/
|
1829
2320
|
ServicesFXPGet: {
|
2321
|
+
parameters: {
|
2322
|
+
query?: never;
|
2323
|
+
header?: never;
|
2324
|
+
path?: never;
|
2325
|
+
cookie?: never;
|
2326
|
+
};
|
2327
|
+
requestBody?: never;
|
1830
2328
|
responses: {
|
1831
2329
|
200: components["responses"]["servicesFXPSucess"];
|
1832
2330
|
400: components["responses"]["400"];
|
1833
2331
|
500: components["responses"]["500"];
|
1834
2332
|
};
|
1835
2333
|
};
|
1836
|
-
/**
|
1837
|
-
* Obtain a list of the DFSPs in the scheme who provide FXP service
|
1838
|
-
* @description The HTTP request `GET /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to request information about the participants in a scheme who offer currency conversion services in a particular currency corridor. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency.
|
1839
|
-
*/
|
1840
2334
|
ServicesFXPSourceCurrencyTargetCurrencyGet: {
|
1841
2335
|
parameters: {
|
2336
|
+
query?: never;
|
2337
|
+
header?: never;
|
1842
2338
|
path: {
|
2339
|
+
/** @description ISO 4217 currency code for the source currency. */
|
1843
2340
|
SourceCurrency: components["parameters"]["SourceCurrency"];
|
2341
|
+
/** @description ISO 4217 currency code for the target currency. */
|
1844
2342
|
TargetCurrency: components["parameters"]["TargetCurrency"];
|
1845
2343
|
};
|
2344
|
+
cookie?: never;
|
1846
2345
|
};
|
2346
|
+
requestBody?: never;
|
1847
2347
|
responses: {
|
1848
2348
|
200: components["responses"]["servicesFXPSucess"];
|
1849
2349
|
400: components["responses"]["400"];
|
1850
2350
|
500: components["responses"]["500"];
|
1851
2351
|
};
|
1852
2352
|
};
|
1853
|
-
/**
|
1854
|
-
* Calculate FX quote
|
1855
|
-
* @description The HTTP request `POST /fxQuotes` is used to ask to provide a quotation for a currency conversion.
|
1856
|
-
*/
|
1857
2353
|
FxQuotesPost: {
|
2354
|
+
parameters: {
|
2355
|
+
query?: never;
|
2356
|
+
header?: never;
|
2357
|
+
path?: never;
|
2358
|
+
cookie?: never;
|
2359
|
+
};
|
1858
2360
|
/** @description Details of the FX quote request. */
|
1859
2361
|
requestBody: {
|
1860
2362
|
content: {
|
@@ -1864,6 +2366,9 @@ export interface operations {
|
|
1864
2366
|
responses: {
|
1865
2367
|
/** @description Successful response. */
|
1866
2368
|
200: {
|
2369
|
+
headers: {
|
2370
|
+
[name: string]: unknown;
|
2371
|
+
};
|
1867
2372
|
content: {
|
1868
2373
|
"application/json": components["schemas"]["FxQuotesPostOutboundResponse"];
|
1869
2374
|
};
|
@@ -1872,11 +2377,13 @@ export interface operations {
|
|
1872
2377
|
500: components["responses"]["500"];
|
1873
2378
|
};
|
1874
2379
|
};
|
1875
|
-
/**
|
1876
|
-
* Perform FX transfer
|
1877
|
-
* @description The HTTP request `POST /fxTransfers` is used to ask to confirm the execution of an agreed currency conversion.
|
1878
|
-
*/
|
1879
2380
|
FxTransfersPost: {
|
2381
|
+
parameters: {
|
2382
|
+
query?: never;
|
2383
|
+
header?: never;
|
2384
|
+
path?: never;
|
2385
|
+
cookie?: never;
|
2386
|
+
};
|
1880
2387
|
/** @description Details of the FX transfer request. */
|
1881
2388
|
requestBody: {
|
1882
2389
|
content: {
|
@@ -1886,6 +2393,9 @@ export interface operations {
|
|
1886
2393
|
responses: {
|
1887
2394
|
/** @description Successful response. */
|
1888
2395
|
200: {
|
2396
|
+
headers: {
|
2397
|
+
[name: string]: unknown;
|
2398
|
+
};
|
1889
2399
|
content: {
|
1890
2400
|
"application/json": components["schemas"]["FxTransfersPostOutboundResponse"];
|
1891
2401
|
};
|